API Documentation
Addons
Entitlements
Alerts
Costs
Credit Grants
Customers
Wallets
Invoices
- GETGet customer invoice summary
- POSTCreate one-off invoice
- POSTGet invoice preview
- POSTQuery invoices
- GETGet invoice
- PUTUpdate invoice
- POSTTrigger invoice communication webhook
- POSTFinalize invoice
- PUTUpdate invoice payment status
- POSTAttempt invoice payment
- GETGet invoice PDF
- POSTRecalculate invoice
- POSTVoid invoice
Entity Integration Mappings
Environments
Events
Payments
Plans
Prices
Price Units
Integrations
Subscriptions
- POSTCreate subscription
- POSTAdd addon to subscription
- DELRemove addon from subscription
- PUTUpdate subscription line item
- DELDelete subscription line item
- POSTQuery subscriptions
- 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
Scheduled Tasks
Tax Associations
Tax Rates
Webhooks
Workflows
Delete 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>"
}Credit Grants
Delete credit grant
Use when removing or ending a credit grant (e.g. revoke promo or close prepaid). Plan-scoped grants are archived; subscription-scoped supports optional effective_date in body.
DELETE
/
creditgrants
/
{id}
Delete 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