SynqDocs
Errors

Error code payment_requires_action (HTTP 402)

What Synq's `payment_requires_action` error code means, when the API answers HTTP 402 Payment Required with it, and how to fix it.

The payment a change needs, ending a trial now or an upgrade, waits for the person's bank to confirm it, 3-D Secure: nothing is charged until they do, and nothing changes. hosted_invoice_url is Stripe's page for its invoice, where the bank's check shows, expires_at when it stops waiting, and change, plan and interval what paying it does.

What to do

Send the person who holds the card to hosted_invoice_url to confirm the payment with their bank; once they do, Stripe takes it, the change applies and GET /v1/orgs/{org}/billing says so. Don't send the change again while it waits: that makes a new invoice and asks the bank again.

FieldValue
codepayment_requires_action
status402 Payment Required
titlePayment requires action

Synq's APIs answer errors with a problem document (RFC 9457, application/problem+json). Its type is the address of this page, and its code is payment_requires_action. Branch on code, never on title or detail: a code never changes once it ships, while the words may.

{
  "type": "…/errors/payment_requires_action",
  "title": "Payment requires action",
  "status": 402,
  "code": "payment_requires_action"
}

See every error code. Still stuck? Support says where to write, what to send and where Synq's status page is.

On this page