How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoca Billing API

The billing API from Zoca — 46 operation(s) for billing.

Zoca Billing API is one of 193 APIs that Zoca publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 63 operations across 46 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 3.20.10.

Requests are made against a single base URL, https://api.zoca.ai.

63 operations 46 paths 2 schemas 5 DELETE29 GET6 PATCH23 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.20.10
Base URL
https://api.zoca.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zoca Billing API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (access-token).

  • access-token — Enter JWT token in the format Bearer

Paths & Operations 63

Across 46 paths, the API surfaces 63 operations — 5 DELETE, 29 GET, 6 PATCH, 23 POST. Each is listed below with its method, path, parameters, and response codes.

billing 63
GET
/billing/customers
Get Chargebee customer ID for a location entity
t_value → 200
GET
/billing/agents
List buyable agents with Chargebee addon info for a plan
t_value → 200
POST
/billing/payment-method/hosted-page
Create Chargebee hosted-page for drop-in payment modal
t_value → 201
POST
/billing/invoices/{invoiceId}/payment-intent
Create paymentintent for an unpaid invoice (handlePayment 3DS)
t_value → 201
POST
/billing/invoices/{invoiceId}/collect-payment
Collect payment for an unpaid invoice (card on file or authorised paymentintent)
t_value → 201
POST
/billing/portal-session
Create Chargebee portalsession for Customer Portal drop-in
t_value → 201
GET
/billing/contract/prefill
Prefill data for the contract Confirm step
t_value → 200
POST
/billing/contract/confirm
Confirm contract details and trigger Zoho signing
t_value → 202
GET
/billing/contract/{contractId}
Poll a single contract by id
t_value → 200202
PATCH
/billing/subscription
Update subscription (items/plan/coupons/pause/resume/reactivate/…)
t_value → 200
DELETE
/billing/subscription
Cancel subscription
t_value → 200400
GET
/billing/subscription
Get the unified billing state for a location
t_value → 200
GET
/billing/cancellation-stats
Aggregated location stats for the cancellation flow
t_value → 200404
GET
/billing/cancellation/reasons
List active cancellation reasons for the cancellation flow
t_value → 200
GET
/billing/cancellation/faqs
List active cancellation FAQs (optionally scoped to a subscription)
t_value → 200
POST
/billing/cancellation/responses
Log the cancellation reason answer (upsert per location × subscription)
t_value → 201
GET
/billing/admin/cancellation-reasons
Admin - list all cancellation reasons (incl. archived)
t_value → 200
POST
/billing/admin/cancellation-reasons
Admin - create a new cancellation reason
t_value → 201
GET
/billing/admin/cancellation-reasons/{id}
Admin - get a single cancellation reason
t_value → 200
PATCH
/billing/admin/cancellation-reasons/{id}
Admin - update title, description, displayOrder, status, or attributes
t_value → 200
DELETE
/billing/admin/cancellation-reasons/{id}
Admin - soft-archive a cancellation reason
t_value → 200
POST
/billing/admin/cancellation-reasons/bulk
Admin - bulk-upsert cancellation reasons (idempotent on reasonKey)
t_value → 201
GET
/billing/admin/cancellation-faqs
Admin - list all cancellation FAQs (incl. archived)
t_value → 200
POST
/billing/admin/cancellation-faqs
Admin - create a new cancellation FAQ
t_value → 201
GET
/billing/admin/cancellation-faqs/{id}
Admin - get a single cancellation FAQ
t_value → 200
PATCH
/billing/admin/cancellation-faqs/{id}
Admin - update question, answer, displayOrder, status, or attributes
t_value → 200
DELETE
/billing/admin/cancellation-faqs/{id}
Admin - soft-archive a cancellation FAQ
t_value → 200
POST
/billing/admin/cancellation-faqs/bulk
Admin - bulk-upsert cancellation FAQs (idempotent on faqKey)
t_value → 201
GET
/billing/admin/cancellation-responses
Admin - list cancellation responses for a location (optionally a sub)
t_value → 200
POST
/billing/subscription/change-estimate
Estimate proration for a subscription change
t_value → 201
GET
/billing/addons/catalog
Addons available to add to the subscription
t_value → 200
GET
/billing/admin/locations/{locationEntityId}/addons-toggle
Admin - read the per-addon visibility toggles for a location
t_value → 200
POST
/billing/admin/locations/{locationEntityId}/addons-toggle
Admin - flip the visibility toggle for a single addon at a location
t_value → 201
POST
/billing/locations/{locationEntityId}/addons-toggle
User - flip a single addon on/off for the location (persists to preferences)
t_value → 201
POST
/billing/addons
Add addons by creating a new subscription at the chosen frequency
t_value → 201
GET
/billing/addons
Addons currently attached to the subscription
t_value → 200
GET
/billing/missed-payments
List overdue invoices + next retry
t_value → 200
GET
/billing/subscription/frequency-options
Project current addon set onto every supported billing frequency
t_value → 200
GET
/billing/payment-methods
List payment methods on the customer
t_value → 200
GET
/billing/invoices
List invoices for a location
t_value → 200
GET
/billing/invoices/{id}/download
Redirect to signed Chargebee PDF URL
t_value → 302
GET
/billing/pricing
List active pricing plans for the checkout plan-selection step
t_value → 200
GET
/billing/pricing/quote
Quote bundle pricing for a specific (frequency, addons) combination
t_value → 200
GET
/billing/admin/plan-pricing
Admin - list all planpricing rows (incl. inactive)
t_value → 200
POST
/billing/admin/plan-pricing
Admin - create a planpricing row
t_value → 201
GET
/billing/admin/plan-pricing/{id}
Admin - get a single planpricing row
t_value → 200
PATCH
/billing/admin/plan-pricing/{id}
Admin - update status, validity window, attributes, or CB item price id
t_value → 200
DELETE
/billing/admin/plan-pricing/{id}
Admin - hard-delete a planpricing row
t_value → 200
GET
/billing/admin/addon-pricing
Admin - list addonpricing rows (incl. inactive)
t_value → 200
POST
/billing/admin/addon-pricing
Admin - create an addonpricing row
t_value → 201
GET
/billing/admin/addon-pricing/{id}
Admin - get a single addonpricing row
t_value → 200
PATCH
/billing/admin/addon-pricing/{id}
Admin - update unitpricecents, status, validity, attributes, or CB id
t_value → 200
DELETE
/billing/admin/addon-pricing/{id}
Admin - hard-delete an addonpricing row
t_value → 200
GET
/billing/agents/status
List agents with active-subscription status for a location
t_value → 200
GET
/billing/state
Get current billing state for a location
t_value → 200404
PATCH
/billing/state
Update billingstate for a location (FE-driven transitions only)
t_value → 200400
POST
/billing/admin/subscriptions/{subscriptionId}/schedule-price-change
Admin - manually schedule a future-dated unitprice change on a subscription
t_value → 201
POST
/billing/admin/contracts/{contractId}/mark-signed
Force-mark a contract as signed (admin override for missed Zoho webhook)
t_value → 200
POST
/billing/subscription/start
Create trial subscription for the signed contract
t_value → 201
POST
/billing/subscription/renew
Renew a cancelled subscription with a fresh plan combination
t_value → 201
POST
/billing/trial/extend
Extend the active trial for a location
t_value → 201
POST
/billing/trial/end
End the active trial for a location immediately
t_value → 201
POST
/billing/customers/ensure
Ensure a Chargebee customer exists for a location entity
t_value → 201

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are t (12 properties), e (6 properties). Each schema is shown below with its type and property counts.

t
object
12 properties 12 required
e
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoca-billing-api-openapi.yml Raw ↑

Other APIs Zoca publishes across the network.

Zoca ACM API
Zoca Acuity API
Zoca Addon Groups API
Zoca Addons API
Zoca Aeo Lead Magnet API
Zoca Agents API
Zoca API Keys API
Zoca App API
Zoca App Blocker API
Zoca App Blocker Updates API
Zoca Approvals API
Zoca Auth API
Where this information came from

This is an independent, third-party profile of Zoca Billing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.