ZapyFlow/Documentación de la APIopenapi.json

Billing

Planes, suscripción y cobros

GET/api/billing/addons

Extras recurrentes contratados por el equipo, con uso y tope efectivo.

Ámbito requerido: billing.read

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

GET/api/billing/cancel-offer

La oferta de retención para un motivo de cancelación

Ámbito requerido: billing.read

ParámetroDóndeObligatorio
reasonquerysí
bash
curl "https://api.zapyflow.com.br/api/billing/cancel-offer?reason=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET/api/billing/entitlements

Derechos activos del equipo: funciones del plan, anulaciones y límites.

Ámbito requerido: workspace.read

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

GET/api/billing/features

Funciones activas del equipo (plan base más anulaciones temporales con expiresAt).

Ámbito requerido: workspace.read

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

GET/api/billing/implementation

Catálogo de implementación asistida y órdenes del equipo.

Ámbito requerido: billing.read

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

GET/api/billing/invoices

Historial de pagos y periodos de suscripción del equipo

Ámbito requerido: billing.read

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

GET/api/billing/payment-attempt

El intento de pago más reciente del equipo.

Ámbito requerido: billing.read

ParámetroDóndeObligatorio
idqueryno
bash
curl "https://api.zapyflow.com.br/api/billing/payment-attempt" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET/api/billing/payment-config

Configuración pública de los métodos de pago.

Ámbito requerido: billing.read

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

GET/api/billing/pix-charge/status

Consultar el estado del pago Pix pendiente

Ámbito requerido: billing.read

bash
curl "https://api.zapyflow.com.br/api/billing/pix-charge/status" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET/api/billing/plan-change-offer

Oferta calculada a partir del uso real, para el cambio de plan.

Ámbito requerido: billing.read

ParámetroDóndeObligatorio
planquerysí
bash
curl "https://api.zapyflow.com.br/api/billing/plan-change-offer?plan=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

GET/api/billing/quota-packs

Saldo de cuota comprada e historial de compras del equipo.

Ámbito requerido: billing.read

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

GET/api/billing/trial-state

Estado de la prueba anticipada de Starter del equipo actual (trialing/active/locked/none)

Ámbito requerido: workspace.read

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

GET/api/billing/usage

Uso mensual y límites del plan

Ámbito requerido: workspace.read

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