---
title: "Portal"
method: POST
path: "/api/billing/portal"
tags: ["billing"]
---

# Portal

`POST /api/billing/portal`

## Request

- Base URL: `https://api.heymetra.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.heymetra.com/api/billing/portal`
- Auth: none declared

A link to the provider's customer portal, where the subscription is
cancelled, resumed and its card and invoices managed.

Opened for the billing customer stored on THIS workspace. One person paying
for several workspaces shares one customer, so the portal lists all of
them; a workspace that never paid has no customer and is refused rather
than handed the one its owner has elsewhere.

## Headers

- `authorization` string, nullable
- `x-workspace-id` string, nullable

## Response `200`

Successful Response

- PortalOut
  - `url` string, required

## Other responses

- `422`: Validation Error

---

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