Skip to main content
POST
Create Portal Session

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Headers

Idempotency-Key
string

Deduplicates retried requests with the same key and parameters instead of creating a second resource. Recommended: an opaque, randomly-generated value such as a UUID.

Path Parameters

provider_billing_portal_id
string
required

Portal configuration ID (e.g. test_billing_portal_id).

Body

application/json
provider_customer_id
string
required

Customer ID in the payment provider.

intent
string
required

Portal intent (cancel or other per PortalSessionIntent enum).

provider_subscription_id
string

Required when intent is cancel.

Response

Success.

data
object
required