---
title: "Open the billing customer portal"
method: POST
path: "/billing/portal"
tags: ["Billing"]
---

# Open the billing customer portal

`POST /billing/portal`

## Request

- Base URL: `https://api.cactal.ai/v1`
- URL: `https://api.cactal.ai/v1/billing/portal`
- Auth: HTTP bearer

Creates a hosted customer billing portal session for managing payment details, invoices, and subscription state. Redirect the customer to the returned URL; they come back to `returnUrl` when provided. Requires the organization owner.

## Request body

- object
  - `organizationId` string, required
  - `returnUrl` string

## Response `200`

The hosted portal session.

- object
  - `url` string, required: Hosted billing portal URL to redirect the customer to.

## Other responses

- `400`: Validation failed. The response `message` names the first invalid field.
- `401`: Missing, invalid, expired, or revoked API key.
- `403`: The authenticated principal lacks the required capability.
- `404`: The resource does not exist or is outside the principal’s access scope.
- `429`: Rate limit exceeded. Retry after the number of seconds in the `Retry-After` header.

---

[API](https://skmtc.dev/cactal/apis/cactal-api.md) · [All operations](https://skmtc.dev/cactal/apis/cactal-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cactal/apis/cactal-api/revisions/9cd0fb5eacdd?raw)