Create a chargebee self-serve customer portal session
Creates a Chargebee self-serve customer portal session (URL, token, and the fields Chargebee.js needs) for the org selected by Organization-Id, Connection-Id, or Entity-Id. Creates the Chargebee customer record on first use, billed to the authenticated identity's name and email. Requires an owner or admin of the organization, or the organization's own API key.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-10-06.
Target organization id (Organization-Id selector).
Target connection id; resolves to its organization.
Platform entity id; resolves to a connection's organization.
Optional source to disambiguate an Entity-Id.
Response
Chargebee portal session id.
Portal session token. Treat as a secret.
One-time portal URL. Treat as a secret.
Portal session status, e.g. created.
When the session was created.
When the portal URL expires.
Chargebee object type, portal_session.
Chargebee customer id the session is for.
Where the portal sends the user on exit, or null.
Other Chargebee customers reachable from this session.
Successful Response
The request was invalid.
Authentication failed or was missing.
The credential is not permitted for this request.
The requested resource was not found.
Validation Error