Create billing portal session

POST https://app.speybooks.com/api/v1/billing/portal

Create a Stripe Customer Portal session for self-service subscription management. The portal allows users to update payment methods, view and download Stripe invoices, and cancel or modify their subscription.

Requires an existing Stripe customer. Returns 400 if no customer record exists (user must subscribe first).

Response

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

Show response fields

portalUrl string

Stripe Billing Portal session URL. Redirect the user here.

Error codes

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

Request POST /v1/billing/portal curl

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

Response 200

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