Skip to content
Console
On this page

Portal sessions

A Portal Session is a hosted page where a subject manages its subscriptions, payment method, and invoices.

A Portal Session is a hosted page where a subject manages its subscriptions, payment method, and invoices.

Service Sylphx Money · Resource type money.sylphx.com/PortalSession · Name pattern orgs/{org}/projects/{project}/envs/{env}/portal_sessions/{portal_session} · Shape record

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/portal_sessions/{portal_session}.
uidstringpts_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
subjectSubjectWhose portal. Required.
return_urlstringWhere the portal's back link goes. HTTPS only. Required.
customer_subscriptionstringOptional owned Stripe subscription whose processor customer opens the portal. Omitted: use the subject's original customer binding.
switch_pricestringThe explicitly allowed annual catalog price key to offer for the named customer_subscription. Opens only a hosted confirmation, not the general portal, and never changes the subscription until the buyer confirms.
urlstringThe hosted page; valid for a few minutes. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
POSTcreateCreates a customer portal session for a subject.
GETgetGets a portal session.

create

Creates a customer portal session for a subject.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/portal_sessions · scope billing:write · effect write · Request, response and examples

get

Gets a portal session.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/portal_sessions/portal-session · scope billing:read · effect read · Request, response and examples