Record Payment For Subscription
Records 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.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Chargify id of the subscription.
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://example.com/subscriptions/0/payments.json" \ -H "Content-Type: application/json" \ -d '{ "payment": { "amount": "10.0", "memo": "to pay the bills", "payment_details": "check number 8675309", "payment_method": "check" } }'{ "paid_invoices": [ { "invoice_id": "inv_bchyhr6z5grby", "status": "paid", "due_amount": "0.0", "paid_amount": "50.0" }, { "invoice_id": "inv_bchyhrgvyb6vm", "status": "paid", "due_amount": "0.0", "paid_amount": "50.0" } ], "prepayment": null}Read Credit Note GET
Returns the details for a credit note.
Reopen Invoice POST
Reopens any invoice with the "canceled" status. Invoices enter "canceled" status if they were open at the time the subscription was canceled (whether through dunning or an intentional cancellation). Invoices with "canceled" status are no longer considered to be due. Once reopened, they are considered due for payment. Payment may then be captured in one of the following ways: - Reactivating the subscription, which will capture all open invoices (See note below about automatic reopening of invoices.) - Recording a payment directly against the invoice A note about reactivations: any canceled invoices from the most recent active period are automatically opened as a part of the reactivation process. Reactivating via this endpoint prior to reactivation is only necessary when you wish to capture older invoices from previous periods during the reactivation. ### Reopening Consolidated Invoices When reopening a consolidated invoice, all of its canceled segments will also be reopened.