Set your account's API version

PUT/tenant/api-versionProbar

URL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

Cabeceras

BC-VersionVersión de la API para ESTA petición. Sin él, la de tu cuenta (`GET /tenant/me` → `apiVersion`). `2026-11-03` es la API en inglés que documenta este contrato. Toda respuesta trae `BC-Version` con la versión con la que salió.

Cuerpo de la petición (JSON){ "version": "2026-11-03" }

Enviar peticiónCopiar como curl

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

PUT

/tenant/api-version

curl --request PUT \
  --url http://localhost:3000/v1/tenant/api-version \
  --header 'BC-Version: 2026-11-03' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "version": "2026-11-03" }'

• Pruebas (sandbox)
• Producción

Scope tenant:write. The version we answer you in by default (responses, errors and webhooks). 2026-11-03 is the API in English, the one this contract documents. Accounts that existed before that date stay on 2026-10-22 (the Spanish names) for 90 days.

To try it without changing anything, send the BC-Version: 2026-11-03 header on a request; when your integration is ready, set it here. You can go back to 2026-10-22 while the window lasts (it doesn’t exist in production). Pending webhooks go out in the new version from then on. In a production account the version also applies to live traffic: set it with an sk_live_ key (with an sk_test_, 403 insufficient_scope). Guide: “Migrate to the English names”.

Authorizations

• ApiKeyAuth

Parameters

Header Parameters

BC-Version

string

Allowed values: 2026-11-03 2026-10-22

Example

2026-11-03

Versión de la API para ESTA petición. Sin él, la de tu cuenta (GET /tenant/me → apiVersion). 2026-11-03 es la API en inglés que documenta este contrato. Toda respuesta trae BC-Version con la versión con la que salió.

Request Body^required

Media typeapplication/json

object

version

required

string

Allowed values: 2026-11-03 2026-10-22

Example

{
  "version": "2026-11-03"
}

Responses

200

Versión fijada

Media typeapplication/json

object

tenantId

string format: uuid

apiVersion

string

previousApiVersion

string

Example

{
  "apiVersion": "2026-11-03",
  "previousApiVersion": "2026-10-22"
}

400

api_version_unsupported (2026-10-22 en producción) o validation_failed (una versión que no existe)

403

insufficient_scope: la key no tiene tenant:write