Customer portal sessions

Customer portal sessions hold authenticated links to the customer portal for a customer.

The customer portal is a secure, Paddle-hosted site that customers can use to manage their own subscriptions, payments, and account information.

You can create a customer portal session to generate authenticated links to the customer portal. This is typically used when linking to the customer portal from your app, where customers are already authenticated.

Customer portal session entities hold authenticated links to the customer portal for a customer, including:

Links to the customer portal overview page.
Deep links to that take customers to specific pages in the portal. For example, the cancellation page for a specific subscription.

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

Customer portal

Use customer portal links in your app

Attributes

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.

generalobject

Authenticated customer portal deep links that aren't associated with a specific entity.

subscriptionsarray[object]

List of generated authenticated customer portal deep links for the subscriptions passed in the subscription_ids array in the request.

If subscriptions are paused or canceled, links open the overview page for a subscription.

Empty if no subscriptions passed in the request.

created_atstring<date-time>

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

Create a customer portal session for a customer

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