Skip to main content
POST

Overview

Creates a Stripe Customer Portal session where users can:
  • Update payment methods
  • View billing history
  • Change subscription plans
  • Download invoices
  • Cancel subscription
Requires session-based authentication (JWT access token).
For third-party integrations: Use POST /subscriptions/portal/api with API Key authentication instead.

Authentication

string
required
Your JWT access token. Format: Bearer YOUR_ACCESS_TOKEN

Request Body

string
URL to redirect to when user exits the portal. Defaults to application dashboard.

Response Fields

string
URL to redirect the user to. This is a Stripe-hosted billing portal.

Portal Capabilities

The Stripe Customer Portal allows users to:

Error Responses

Bad Request - No billing account found. User must make a purchase first.
Unauthorized - Invalid or missing token.
The billing portal is only available for users who have previously made a purchase or have an active subscription. New users should use the checkout endpoint instead.

POST /subscriptions/portal/api

Creates a Stripe Customer Portal session using API Key authentication. Ideal for third-party integrations.

Authentication

Requires API Key authentication. Include your API key in the Authorization header:

Request Body

Same as /subscriptions/portal above.

Response

Same as /subscriptions/portal above.

Best Practices

  • Link in settings: Add a “Manage Billing” button in your app’s settings page
  • After checkout: Redirect users to the portal after subscription purchase
  • Support: Provide portal access as a self-service option for billing issues