Skip to main content
POST
Open the billing portal

Authorizations

Authorization
string
header
required

A dashboard session — the short-lived JWT a signed-in human holds at the dashboard, sent on the same Authorization: Bearer header. Dispatched by shape: a session token is a JWT, an API key starts with ck_. Sessions cannot be created through this API, and operations that list only this scheme refuse API keys with 401.

Response

The portal URL.

A Stripe-hosted page to send the browser to. Farthing never sees the card or the ID document — the flow happens on Stripe's pages.

url
string<uri>
required