Create Prepayment
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Creates a prepayment for a subscription.
In order to specify a prepayment made against a subscription, specify the amount, memo, details, method.
When the method specified is "credit_card_on_file", the prepayment amount will be collected using the default credit card payment profile and applied to the prepayment account balance. This is especially useful for manual replenishment of prepaid subscriptions.
Note that passing amount_in_cents is now allowed.
When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication.
See the 3D Secure Post-Authentication Flow article in the product documentation to learn how to manage the redirect flow.
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/prepayments.json' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "prepayment": { "amount": 100, "details": "John Doe signup for $100", "memo": "Signup for $100", "method": "check" }}'