---
title: "Open the caller's billing settings"
method: POST
path: "/api/v1/me/billing/settings-sessions"
tags: ["Me"]
---

# Open the caller's billing settings

`POST /api/v1/me/billing/settings-sessions`

## Request

- Base URL: `https://entire.io` (the document declares no server; this is the origin it was published from)
- URL: `https://entire.io/api/v1/me/billing/settings-sessions`
- Auth: none declared

Opens the billing provider's settings page, where the caller changes the card, billing address and tax ID. return_url must be an https URL on entire.io or partial.to; the first billing read after the return should pass refresh=card. A 409 billing_not_active means billing is not set up yet.

## Request body

- object
  - `return_url` string, required

## Response `201`

The billing settings URL to send the caller to.

- object
  - `billing_settings_url` string, required: Where the caller edits the card, billing address and tax ID. Valid briefly.

## Other responses

- `400`: Invalid request
- `401`: Not authenticated
- `403`: Access denied
- `404`: Resource not found
- `409`: Resource conflict
- `412`: Precondition failed
- `422`: Validation failed
- `429`: Too many requests
- `502`: Entire Core request failed
- `503`: Entire Core is unavailable. Type "billing-not-configured" means billing is not configured.

## Changes

- **2026-10-21** `186d0f52dbfb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/entire/apis/entire-api/changes/api/v1/me/billing/settings-sessions/post.md)

---

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