Cancel an installment
Removes an installment from the active plan. A paid installment cannot be canceled.
Removes an installment from the active plan. A paid installment cannot be canceled.
Authorization
bearerAuth payments:deleteA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: payments:delete
Path Parameters
Header Parameters
Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "deleted": true}{ "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}Plan an invoice's installments POST
Creates (or replaces) the invoice's payment plan: an ordered set of installments, each collectable via a hosted checkout. The plan total may not exceed the invoice total.
List an invoice's installments GET
Lists the planned installments (deposit + scheduled payments) on an invoice, in plan order.