Axuz Developers

POST /v1/teams/{teamId}/billing/subscription/upgrade

Upgrade/downgrade OU criação com trial anti-farming

  • Acesso: Admin da equipe
  • Serviço: https://api-billing.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

Responde POST /teams/{teamId}/billing/ subscription/upgrade.

AUTORIZAÇÃO (G-030): owner/admin do time. Apesar do nome, a rota é a troca de plano do lado do cliente nos DOIS sentidos — passa qualquer plano para ApplyProration, inclusive um mais barato —, então é ela que atende "upgrade/downgrade dentro do app sem sair pro gateway". Membro comum recebe 403.

Dois modos: (1) já existe subscription → change-plan com proração (ApplyProration); (2) primeira vez → INSERT nova subscription (trial se aplicável e nunca teve; senão active). Trial anti-farming: só concede se a equipe nunca teve subscription (EXISTS). Efeitos: leituras + UPDATE ou INSERT em subscriptions.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
plan_idstring<uuid>sim
billing_cyclestringnão

enum: "monthly", "yearly"

{
  "plan_id": "00000000-0000-0000-0000-000000000000",
  "billing_cycle": "monthly"
}

Respostas

200

upgrade aplicado

NomeTipoObrigatórioDescrição
okbooleannão
idstring<uuid>não
modestringnão

enum: "upgrade"

prorationBillingProrationResultnão
proration.change_kindstringnão

enum: "upgrade", "downgrade", "cancel"

proration.credit_centsintegernão
proration.charge_centsintegernão
proration.net_centsintegernão
proration.invoice_idstring<uuid> | nullnão
proration.proration_item_idstring<uuid>não

201

nova subscription criada

NomeTipoObrigatórioDescrição
okbooleannão
idstring<uuid>não
modestringnão

enum: "create"

400

input inválido

NomeTipoObrigatórioDescrição
errorstringsim

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

erro interno

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X POST 'https://api-billing.axuz.net/v1/teams/TEAM_ID/billing/subscription/upgrade' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"plan_id":"00000000-0000-0000-0000-000000000000","billing_cycle":"monthly"}'

Node.js

const res = await fetch("https://api-billing.axuz.net/v1/teams/TEAM_ID/billing/subscription/upgrade", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "plan_id": "00000000-0000-0000-0000-000000000000",
    "billing_cycle": "monthly"
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://api-billing.axuz.net/v1/teams/TEAM_ID/billing/subscription/upgrade",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "plan_id": "00000000-0000-0000-0000-000000000000",
        "billing_cycle": "monthly",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())