Paddle Billing
Search

Create a customer portal session

posthttps://api.paddle.com/customers/{customer_id}/portal-sessions

Creates a customer portal session for a customer. You can use this to generate authenticated links for a customer so that they're automatically signed in to the portal. Typically used when linking to the customer portal from your app where customers are already authenticated.

You can include an array of subscription_ids to generate authenticated portal links that let customers make changes to their subscriptions. You can use these links as part of subscription management workflows rather than building your own billing screens.

Customer portal sessions are temporary and shouldn't be cached.

The customer portal is fully hosted by Paddle. For security and the best customer experience, don't embed the customer portal in an iframe.

Path Parameters

customer_idstringrequired

Paddle ID of the customer entity to work with.

Request Body

subscription_idsarray[string]

Paddle ID of a subscription related to this customer to create an authenticated customer portal deep link for.

Response

dataobject

Represents a customer portal session.

idstring

Unique Paddle ID for this customer portal session entity, prefixed with cpls_.

customer_idstring

Paddle ID of the customer that this customer portal sessions is for, prefixed with ctm_.

urlsobject

Authenticated customer portal deep links. For security, the token appended to each link is temporary. You shouldn't store these links.

created_atstring<date-time>

RFC 3339 datetime string of when this customer portal session was created.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.