Refund Prepayment
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Refunds a prepayment applied to a subscription, either fully or partially. The prepayment_id will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded.
The amount may be passed either as a decimal, with amount, or an integer in cents, with amount_in_cents.
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.
id of prepayment
int64application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
curl -X POST \ --url 'https://subdomain.chargify.com/subscriptions/1/prepayments/1/refunds.json' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "refund": { "amount_in_cents": 1, "amount": "100.00", "memo": "memo" }}'