Error

A valid request URL is required to generate request examples

{
  "url": "<string>"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Customer billing

Open the gateway's billing portal

Answers a URL to the gateway’s own hosted page where the payer manages what they already have — the card, the receipts, whatever the gateway offers natively. Owner-only.

The gateway is resolved from what the team has actually paid through — its most recent subscription that exists at one — never from a request field: a portal is a page about an existing payer, and the subscription is the only place the payer provably exists. A team that has never completed a payment has no payer for a portal to manage and answers 409.

A gateway with no hosted portal answers 501: a refusal, never a page of ours pretending to be one.

POST

contact

customer

billing

portal-link

Error

A valid request URL is required to generate request examples

{
  "url": "<string>"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Autorizações

Authorization

string

header

obrigatório

A contact session token, uk_ct_…. Belongs to one of the developer's own users, and reads only that user's data.

Cabeçalhos

X-Customer-Id

string<uuid>

The customer this call is acting inside — the same arrangement as X-Organization-Id, one plane down. Switching customers is navigation, not a mutation: nothing is stored, you send a different header, and the membership JOIN behind it decides what you may do there. An id you are not a member of matches no row and answers 404. Absent, the contact's oldest membership answers.

Corpo

application/json

return_url

string<uri>

Where the gateway sends the person back. Optional — a gateway with a configured default returns them itself.

Resposta

Send the person here.

url