ZapyFlow/Documentação da APIopenapi.json

Billing

Planos, assinatura e cobranca

GET/api/billing/addons

Extras recorrentes contratados pelo time, com uso e teto efetivo.

Escopo exigido: billing.read

bash
curl "https://api.zapyflow.com.br/api/billing/addons" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/cancel-offer

A oferta de retenção para um motivo de cancelamento

Escopo exigido: billing.read

ParâmetroOndeObrigatório
reasonquerysim
bash
curl "https://api.zapyflow.com.br/api/billing/cancel-offer?reason=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

GET/api/billing/entitlements

Entitlements ativos do time: features do plano, overrides e limites.

Escopo exigido: workspace.read

bash
curl "https://api.zapyflow.com.br/api/billing/entitlements" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/features

Features ativas do team (plano base + overrides temporários com expiresAt).

Escopo exigido: workspace.read

bash
curl "https://api.zapyflow.com.br/api/billing/features" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/implementation

Catalogo de implantacao assistida e ordens do time.

Escopo exigido: billing.read

bash
curl "https://api.zapyflow.com.br/api/billing/implementation" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/invoices

Histórico de pagamentos e períodos de assinatura do time

Escopo exigido: billing.read

bash
curl "https://api.zapyflow.com.br/api/billing/invoices" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/payment-attempt

A tentativa de pagamento mais recente do time.

Escopo exigido: billing.read

ParâmetroOndeObrigatório
idquerynão
bash
curl "https://api.zapyflow.com.br/api/billing/payment-attempt" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

GET/api/billing/payment-config

Configuração pública dos métodos de pagamento.

Escopo exigido: billing.read

bash
curl "https://api.zapyflow.com.br/api/billing/payment-config" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/pix-charge/status

Verificar status do pagamento PIX pendente

Escopo exigido: billing.read

bash
curl "https://api.zapyflow.com.br/api/billing/pix-charge/status" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

GET/api/billing/plan-change-offer

Oferta calculada a partir do uso real, para a troca de plano.

Escopo exigido: billing.read

ParâmetroOndeObrigatório
planquerysim
bash
curl "https://api.zapyflow.com.br/api/billing/plan-change-offer?plan=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/quota-packs

Saldo de cota comprada e historico de compras do time.

Escopo exigido: billing.read

bash
curl "https://api.zapyflow.com.br/api/billing/quota-packs" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/trial-state

Estado do trial forward de Starter do team logado (trialing/active/locked/none)

Escopo exigido: workspace.read

bash
curl "https://api.zapyflow.com.br/api/billing/trial-state" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/billing/usage

Retorna uso mensal e limites do plano

Escopo exigido: workspace.read

bash
curl "https://api.zapyflow.com.br/api/billing/usage" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK