ZapyFlow/API documentationopenapi.json

Billing

Plans, subscription and billing

GET/api/billing/addons

Recurring add-ons the team has contracted, with usage and effective ceiling.

Required scope: billing.read

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

GET/api/billing/cancel-offer

The retention offer for a given cancellation reason

Required scope: billing.read

ParameterInRequired
reasonqueryyes
bash
curl "https://api.zapyflow.com.br/api/billing/cancel-offer?reason=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 404 — Not found — also returned when the resource belongs to another workspace

GET/api/billing/entitlements

The team's active entitlements: plan features, overrides and limits.

Required scope: workspace.read

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

GET/api/billing/features

The team's active features (base plan plus temporary overrides with expiresAt).

Required scope: workspace.read

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

GET/api/billing/implementation

Assisted implementation catalogue and the team's orders.

Required scope: billing.read

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

GET/api/billing/invoices

The team's payment history and subscription periods

Required scope: billing.read

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

GET/api/billing/payment-attempt

The team's most recent payment attempt.

Required scope: billing.read

ParameterInRequired
idqueryno
bash
curl "https://api.zapyflow.com.br/api/billing/payment-attempt" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 404 — Not found — also returned when the resource belongs to another workspace

GET/api/billing/payment-config

Public configuration of the payment methods.

Required scope: billing.read

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

GET/api/billing/pix-charge/status

Check the status of a pending Pix payment

Required scope: billing.read

bash
curl "https://api.zapyflow.com.br/api/billing/pix-charge/status" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 404 — Not found — also returned when the resource belongs to another workspace

GET/api/billing/plan-change-offer

Offer calculated from real usage, for changing plans.

Required scope: billing.read

ParameterInRequired
planqueryyes
bash
curl "https://api.zapyflow.com.br/api/billing/plan-change-offer?plan=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

GET/api/billing/quota-packs

Purchased quota balance and the team's purchase history.

Required scope: billing.read

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

GET/api/billing/trial-state

State of the Starter forward trial for the current team (trialing/active/locked/none)

Required scope: workspace.read

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

GET/api/billing/usage

Monthly usage and the plan's limits

Required scope: workspace.read

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