latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

User APIs
payments

Get Customer Portal Url

get/api/v1/payments/me/customer-portal

Query parameters

type'payment_method_update' | 'subscription_cancel' | 'subscription_update' | 'billing_update'

Type of customer portal session

Type of customer portal session

return_urlstring nullable

URL to redirect to after the customer portal session

URL to redirect to after the customer portal session

Response

Successful Response

client_idstring required

Client ID used for the request

stripe_customer_idstring required

Stripe customer ID found for the client

session_idstring required

Stripe customer portal session ID

urlstring required

Customer portal URL

return_urlstring required

Return URL for after the session

customer_idstring required

Stripe customer ID

createdinteger required

Timestamp when the session was created