Collect an installment
Mints a hosted Stripe Checkout link for a single installment's amount and returns its URL. The webhook marks the installment paid when it settles.
Mints a hosted Stripe Checkout link for a single installment's amount and returns its URL. The webhook marks the installment paid when it settles.
Authorization
bearerAuth payments:createA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: payments:create
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.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Mint a hosted Stripe Checkout link for a single installment.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "invoice_id": "string", "stripe_session_id": "string", "stripe_payment_intent_id": "string", "url": "string", "status": "open", "amount_cents": -9007199254740991, "currency": "string", "expires_at": "string", "created_at": "string", "updated_at": "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}Arm or disarm installment auto-charge POST
Arms an installment to be charged off-session against a saved payment method on its due date (or disarms it with `method_id: null`). A decline is surfaced on the installment and can be retried by re-arming.
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.