Create billing portal session

POST

/billing/portal

Creates a billing portal session. The portal allows customers to view usage, manage subscriptions, update payment methods, and view invoices. The portal URL is valid for a limited time. Redirect the user to the returned URL.

Authorizations

• bearer_auth

Request Body ^required

Request body for creating a billing portal session.

object

return_url

URL to redirect to after the customer exits the portal.

string | null

Example

{
  "return_url": "https://app.primatomic.com/billing"
}

Responses

200

Portal session created

Response containing the billing portal URL.

object

url

required

URL to redirect the customer to for accessing the billing portal.

string

Example

{
  "url": "https://billing.stripe.com/p/session/test_abc123"
}

401

Unauthorized

402

Billing not configured

Error response for billing operations.

object

error

required

Error message.

string

Example

{
  "error": "Billing service not available"
}

500

Server error

Error response for billing operations.

object

error

required

Error message.

string

Example

{
  "error": "Billing service not available"
}

503

Billing service unavailable

Error response for billing operations.

object

error

required

Error message.

string

Example

{
  "error": "Billing service not available"
}