BillKit/DocsConsole
Billing portal

Revoke portal session

Invalidate a portal session you minted that is already out in the world.

POST/v1/billing_portal/sessions/{session_id}/revoke
Operation revoke_portal_session·Scope subscriptions:write·OpenAPI v1.1.0

Parameters

ParameterDescription
session_idstring · pathrequiredId of the billing portal session, which starts bps_.

Returns

Returns a BillingPortalSessionRevokeResponse 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/bps_9XKp2vQ1/revoke \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "customer_id": "cus_9XKp2vQ1",
  "id": "obj_9XKp2vQ1",
  "livemode": false,
  "object": "billing_portal.session",
  "revoked_at": 1789392000,
  "subscription_id": "sub_9XKp2vQ1"
}