Mint an invoice share link
Creates a public tokenized link for an invoice, optionally passcode-protected and/or time-limited. Returns the one-time token and share path.
Creates a public tokenized link for an invoice, optionally passcode-protected and/or time-limited. Returns the one-time token and share path.
Authorization
bearerAuth sales:createA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: sales: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 public link for an invoice (optional passcode / expiry).
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", "expires_at": "string", "revoked_at": "string", "has_passcode": true, "sent_at": "string", "first_viewed_at": "string", "last_viewed_at": "string", "view_count": -9007199254740991, "created_at": "string", "token": "string", "share_path": "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}Send an invoice by email POST
Mints a public link for the invoice and emails it to the recipient as the acting member's connected mailbox. Requires a first-party session with a connected mailbox.
List an invoice's share links GET
Lists the public links minted for an invoice, newest first, with their send/open history.