BillKit/DocsConsole
Billing portal

Create portal session

Create a billing portal link for one subscription's customer.

POST/v1/billing_portal/sessions
Operation create_portal_session·Scope subscriptions:write·OpenAPI v1.1.0

Parameters

ParameterDescription
return_urlstring (uri)requiredWhere the portal sends the customer when they leave it. Must be an absolute URL. At most 2083 characters.
subscription_idstringrequiredId of the subscription the portal session covers. At most 64 characters.
deliver_emailbooleanoptionalAlso email the portal link to the customer's address on file. When they have none, no email is sent and the session is still created. Defaults to false.

Returns

Returns a BillingPortalSessionResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the subscriptions:write scope.
404No such object in this account and mode.
409Conflicts with the object's current state (state_conflict, or a more specific code), or an operation still in flight (operation_pending).
413The request body is larger than the API accepts.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
502The payment provider failed or did not answer.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X POST https://api.billkit.eu/v1/billing_portal/sessions \
  -H "Authorization: Bearer $BILLKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"return_url":"https://acme.example/welcome","subscription_id":"sub_9XKp2vQ1"}'
Request body · every field
{
  "deliver_email": false,
  "return_url": "https://acme.example/welcome",
  "subscription_id": "sub_9XKp2vQ1"
}
Response · 200 OK
{
  "created": 1789392000,
  "customer_id": "cus_9XKp2vQ1",
  "expires_at": 1789392000,
  "id": "obj_9XKp2vQ1",
  "livemode": false,
  "object": "billing_portal.session",
  "return_url": "https://acme.example/welcome",
  "subscription_id": "sub_9XKp2vQ1",
  "token": "string",
  "url": "https://acme.example/welcome"
}