---
title: "Create billing portal session"
method: POST
path: "/billing/portal/"
tags: ["billing"]
---

# Create billing portal session

`POST /billing/portal/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/billing/portal/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Create a billing portal session to manage payment methods and invoices, and to cancel the subscription. This API is only available for paid plans. If you call this API for a free plan, you will get a validation error.

## Request body

- BillingPortalRequest: Request schema for creating a billing portal session.
  - `return_path` string: Partial path (e.g. /billing) the portal's 'return to site' link goes to.

## Response `200`

Successful Response

- BillingPortalResponse: Response schema for billing portal session.
  - `url` string, uri, required: The URL to redirect the customer to access the billing portal.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)