Create a Stripe customer portal session | API reference

Description

Creates a Stripe customer portal session where an administrator updates payment details or downloads invoices, and returns its URL, or null when Stripe is not configured or the organization has no live Stripe subscription. Only organization administrators may call it, and returnUrl must be on an approved app origin.

Authentication

Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.

Parameters

Name	In	Type	Details
`organizationId`	path	string	required lowercase UUID v4

Request body

application/jsonStripeReturnUrlRequest

Where Stripe sends the browser back after a hosted flow.

1 field

returnUrlstringrequired
Absolute HTTP(S) URL on one of the app origins the server allows.

Other fields are allowed.

Responses

200 OK

application/jsonStripePortalResponse

A Stripe customer portal page.

1 field

portalUrlstringrequirednullable
Portal URL, or null when Stripe is not configured or the organization has no live Stripe subscription.

Other fields are allowed.

Other responses

Status	Meaning	Body
400	Bad Request	`application/json`ErrorResponse
401	Unauthorized	`application/json`SessionFailureResponse
403	Forbidden	`application/json`ErrorResponse
404	Not Found	`application/json`ErrorResponse
500	Internal Server Error	`application/json`ErrorResponse
502	Bad Gateway	`application/json`ErrorResponse
503	Service Unavailable	`application/json`ErrorResponse

Additional rules

The server also enforces these rules, which the schema above cannot express.

returnUrl parses as HTTP(S) and its origin matches the configured app origins.