List an invoice's installments
Lists the planned installments (deposit + scheduled payments) on an invoice, in plan order.
Lists the planned installments (deposit + scheduled payments) on an invoice, in plan order.
Authorization
bearerAuth payments:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: payments:read
Path Parameters
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "data": [ { "id": "string", "invoice_id": "string", "sequence": -9007199254740991, "label": "string", "amount_cents": -9007199254740991, "due_date": "string", "status": "scheduled", "payment_id": "string", "auto_charge_method_id": "string", "auto_charge_attempted_at": "string", "auto_charge_error": "string", "reminder_sent_at": "string", "created_at": "string", "updated_at": "string" } ], "next_cursor": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}Cancel an installment DELETE
Removes an installment from the active plan. A paid installment cannot be canceled.
Create a payment link POST
Creates a hosted Stripe Checkout link for the invoice's outstanding balance (or a partial amount) and returns its URL. Requires a connected Stripe account with charges enabled.