Update an invoice
Updates an invoice's status, dates, or amounts (e.g. record a payment or mark it paid).
Updates an invoice's status, dates, or amounts (e.g. record a payment or mark it paid).
Authorization
bearerAuth sales:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: sales:update
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.
Patch an invoice's status, dates, amounts, or addresses.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "sale_id": "string", "invoice_number": "string", "status": "unpaid", "issued_date": "string", "due_date": "string", "subtotal_cents": -9007199254740991, "discount_cents": -9007199254740991, "discount_bps": -9007199254740991, "tax_cents": -9007199254740991, "shipping_cents": -9007199254740991, "shipping_tax_cents": -9007199254740991, "total_cents": -9007199254740991, "amount_paid_cents": -9007199254740991, "accepted_payment_methods": [ "card" ], "currency": "string", "fx_as_of": "string", "fx_usd_per_unit": 0, "fx_base_currency": "string", "fx_base_usd_per_unit": 0, "base_amount_cents": -9007199254740991, "billing_name": "string", "billing_address": "string", "shipping_name": "string", "shipping_address": "string", "tax_address_line1": "string", "tax_address_city": "string", "tax_address_state": "string", "tax_address_postal_code": "string", "tax_address_country": "string", "tax_calculated_at": "string", "taxability_override": "none", "notes": "string", "archived_at": "string", "template_id": "string", "metadata": { "property1": "string", "property2": "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}Create a card-present payment intent POST
Creates a card-present Stripe PaymentIntent on the gallery's connected account for the invoice's outstanding balance (or a partial amount) and returns its client secret for the Terminal SDK. Requires a connected Stripe account with charges enabled.
Get the gallery's invoice settings GET
Returns the gallery's invoice presentation settings (rich-text blocks). Falls back to empty defaults when unset.