Record Payment For Subscription
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Records an external payment made against a subscription that will pay partially or in full one or more invoices.
Payment will be applied starting with the oldest open invoice and then next oldest, and so on until the amount of the payment is fully consumed.
Excess payment will result in the creation of a prepayment on the Invoice Account.
Only ungrouped or primary subscriptions may be paid using the "bulk" payment request.
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.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
curl -X POST \ --url 'https://subdomain.chargify.com/subscriptions/1/payments.json' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "payment": { "amount": "10.0", "memo": "to pay the bills", "payment_details": "check number 8675309", "payment_method": "check" }}'