Billing

Create a customer self-service portal session

Returns a single-use URL valid for one hour. Open it in the customer's browser; it shows their subscriptions, payment history and receipts, and lets them cancel, update the card or pay what is outstanding as your portal settings allow.

post/api/v1/customer-portal/sessions

Request

  • Base URL
    https://merchant.zahlo.eu
  • Auth
    API key in header x-api-key

Headers

Idempotency-Keystring

Retry-safe key for create operations.

Request body

customerIdstring required
returnUrlstring uri required

Absolute https URL the portal's back link goes to.

locale'en' | 'de'

Response

Portal session created

idstring required
object'billing_portal_session' required
livemodeboolean
createdAtstring date-time
customerIdstring required
urlstring uri required
returnUrlstring uri required
expiresAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.