Create Portal Session

POST/api/v1/billing/portal

Create a Stripe Billing Portal session for subscription management.

Operation ID: create_portal_session_api_v1_billing_portal_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: PortalRequest

return_urlstringrequired: URL to redirect after leaving the portal.

Responses

201Successful Response

Schema: SuccessEnvelope_CreatePortalSessionResponse_

successboolean
messagestring
codestring
dataCreatePortalSessionResponse

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/billing/portal

bash

curl -X POST 'https://api.ondayzero.com/api/v1/billing/portal' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "return_url": "string"
}'