billing

Create Portal Session

Create a billing portal session for the calling key.

Requires the X-API-Key header — the calling key's subscription is the one that will be managed. The portal lets the user update their payment method, view invoices, and cancel their subscription. Requires the key to have an associated billing customer (i.e. has paid at least once).

post/api/billing/portal

Request

  • Base URL: https://api.halalterminal.com
  • URL: https://api.halalterminal.com/api/billing/portal
  • Auth: API key in header X-API-Key

Request body

api_keystring nullable

Deprecated — set the X-API-Key header instead. If provided here it must match the header value.

Example request

{}

Response

Billing portal session URL

portal_urlstring required

URL of the billing portal session

Example response

{
  "portal_url": "https://billing.example.com/p/session/test_xyz"
}

Changes

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