Refund Invoice
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Refunds an invoice, segment, or consolidated invoice.
A refund less than the total of a consolidated invoice will be split across its segments.
For a $50.00 refund on a $100.00 consolidated invoice with one $60.00 segment and one $40.00 segment, the refunded amount will be applied as 50% of each ($30.00 and $20.00, respectively).
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 unique identifier for the invoice, this does not refer to the public facing invoice number.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
curl -X POST \ --url 'https://subdomain.chargify.com/invoices/uid/refunds.json' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "refund": { "amount": "100.00", "memo": "Refund for Basic Plan renewal", "payment_id": 12345, "external": false, "apply_credit": false, "void_invoice": true }}'