Delete Prepaid Usage Allocation
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Deletes a prepaid usage allocation.
Prepaid Usage components are unique in that their allocations are always additive. In order to reduce a subscription's allocated quantity for a prepaid usage component, each allocation must be destroyed individually via this endpoint.
By default, destroying an allocation will generate a service credit on the subscription. This behavior can be modified with the optional credit_scheme parameter on this endpoint. The accepted values are:
none: The allocation will be destroyed and the balances will be updated but no service credit or refund will be created.credit: The allocation will be destroyed and the balances will be updated and a service credit will be generated. This is also the default behavior if the credit_scheme param is not passed.refund: The allocation will be destroyed and the balances will be updated and a refund will be issued along with a Credit Note.The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
The Chargify id of the subscription.
The Advanced Billing id of the component
The Advanced Billing id of the allocation
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
curl -X DELETE \ --url 'https://subdomain.chargify.com/subscriptions/1/components/1/allocations/1.json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "credit_scheme": "none"}'Value in