Create billing portal session

POSThttps://app.speybooks.com/api/v1/billing/portal

Creates a Stripe Customer Portal session for self-service subscription management and returns the portal URL. The portal lets the customer update payment methods, view and download Stripe invoices, and cancel or modify the subscription.

Requires an existing Stripe customer. An organisation that has not reached Checkout has no customer record and must subscribe first.

Response

200Returns a Stripe Billing Portal URL. Redirect the user to manage their subscription, invoices, and payment method.

Show response fields

portalUrlstring

Stripe Billing Portal session URL. Redirect the user here.

Error codes

400No active subscription found. The organisation must complete checkout first.

RequestPOST/v1/billing/portalcurl

curl -X POST https://api.speybooks.com/v1/billing/portal \
  -H "Authorization: Bearer sk_test_..."

Response200

{
  "success": true,
  "data": {
    "portalUrl": "https://billing.stripe.com/p/session/bps_..."
  }
}