Create a payment link
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.
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.
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 an invoice.
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}