Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →

Data behind the payment-update page

GET

/v1/public/payment-updates/{token}

const url = 'http://localhost:8080/v1/public/payment-updates/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/v1/public/payment-updates/example

Unauthenticated. The token from the payment-update email is the only credential. It is valid for 24 hours, and starting checkout uses it up. Share the page link with customers instead of calling this route.

Parameters

Path Parameters

token

required

string

Responses

200

What the page shows.

application/json

What the payment-update page shows before the customer adds a card.

object

customer_name

required

string

invoice_number

required

string

invoice_status

required

Lifecycle state of the invoice. uncollectible marks an invoice a dunning policy has given up collecting (no further retries) while keeping it on the books — distinct from voided (cancelled, owes nothing).

string

Allowed values: draft finalized paid voided uncollectible

amount_due_cents

required

Not cleared when the invoice is voided. Check invoice_status before asking for payment.

integer format: int64

currency

required

string

branding

required

object

company_name

string

company_email

string

logo_url

string

brand_color

string

support_url

string

Example

{
  "invoice_status": "draft"
}

401

The token is unknown, expired or already used. Code invalid_token.

application/json

object

error

object

type

One of invalid_request_error, authentication_error, rate_limit_error or api_error. Every error the API answers has this shape, including an unknown path (404, code route_not_found) and a method the path does not take (405, code method_not_allowed, with an Allow header). The few exceptions are listed in docs/api-surface.md.

string

code

string

message

string

request_id

string

param

The request field the error is about. Sent only when the error names one. A request body may hold only the fields its operation lists, spelled and cased as listed: any other field, or one the server sets (such as id), is refused with 422 and param naming it. An operation with no request body lists no fields: send no body, {} or null. The Stripe and Postmark webhooks and the LiteLLM callback take their sender’s body as it comes.

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

404

The invoice or customer the token names is gone. Code invoice_not_found or customer_not_found.

application/json

object

error

object

type

string

code

string

message

string

request_id

string

param

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Rate limited (60/min/IP)