Chargebee Subscriptions API
The Subscriptions API from Chargebee — 2 operation(s) for subscriptions.
Chargebee Subscriptions API is one of 8 APIs that Chargebee publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and a getting-started guide.
This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.
Requests are made against a single base URL, https://{site}.chargebee.com/api/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Chargebee Subscriptions API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic Auth. Username is your Chargebee site API key; password is empty.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Customer (6 properties), Subscription (5 properties), SubscriptionList (2 properties), SubscriptionEnvelope (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Chargebee 7
Other APIs Chargebee publishes across the network.