---
title: "Open the customer billing portal"
method: POST
path: "/v1/workspaces/{workspaceId}/billing/portal"
---

# Open the customer billing portal

`POST /v1/workspaces/{workspaceId}/billing/portal`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/billing/portal`
- Auth: HTTP bearer

## Path parameters

- `workspaceId` string, uuid, required

## Response `200`

Successful response.

- object
  - `data` object, required
    - `url` string, uri, required

## Other responses

- `default`: Request failed.

---

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