API Documentation
Addons
Entitlements
Alert Logs
Connections
Costs
Coupons
CreditGrants
Credit Notes
Customers
Wallets
Invoices
- GETGet a customer invoice summary
- GETList invoices
- POSTCreate a new one off invoice
- POSTGet a preview invoice
- POSTList invoices by filter
- GETGet an invoice by ID
- PUTUpdate an invoice
- POSTTrigger communication webhook for an invoice
- POSTFinalize an invoice
- PUTUpdate invoice payment status
- POSTAttempt payment for an invoice
- GETGet PDF for an invoice
- POSTRecalculate invoice totals and line items
- POSTVoid an invoice
Entity Integration Mappings
Environments
Events
Features
Payments
Plans
CustomerPortal
Prices
Price Units
Integrations
Subscriptions
- GETList subscriptions
- POSTCreate subscription
- POSTAdd addon to subscription
- DELRemove addon from subscription
- PUTUpdate subscription line item
- DELDelete subscription line item
- POSTList subscriptions by filter
- POSTGet usage by subscription
- GETGet subscription
- PUTUpdate subscription
- POSTActivate draft subscription
- GETGet active addon associations
- POSTCancel subscription
- POSTExecute subscription plan change
- POSTPreview subscription plan change
- GETGet subscription entitlements
- GETGet upcoming credit grant applications
- POSTCreate subscription line item
- POSTPause a subscription
- GETList all pauses for a subscription
- POSTResume a paused subscription
- GETGet subscription V2
- GETList all subscription schedules
- GETGet subscription schedule
- POSTCancel subscription schedule
- GETList subscription schedules
Tasks
ScheduledTasks
Tax Associations
Tax Rates
Delete a credit grant
Copy
curl --request DELETE \
--url https://us.api.flexprice.io/v1/creditgrants/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"effective_date": "<string>"
}
'Copy
{
"message": "<string>"
}CreditGrants
Delete a credit grant
Delete a credit grant. Plan-scoped grants are archived; subscription-scoped grants have their end date set (optional body with effective_date). Request body is optional.
DELETE
/
creditgrants
/
{id}
Delete a credit grant
Copy
curl --request DELETE \
--url https://us.api.flexprice.io/v1/creditgrants/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"effective_date": "<string>"
}
'Copy
{
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Credit Grant ID
Body
application/json
Optional: effective_date for subscription-scoped grants
EffectiveDate is optional; when set (subscription scope) the grant end date is set to this time.
Response
OK
⌘I