Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chargebee Customers API

The Customers API from Chargebee — 2 operation(s) for customers.

Chargebee Customers 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 Customers. 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.

3 operations 2 paths 4 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://{site}.chargebee.com/api/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Chargebee Customers 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.

Customers 3
GET
/customers
List customers
listCustomers 2 params → 200
POST
/customers
Create a customer
createCustomer body → 200
GET
/customers/{customer_id}
Retrieve a customer
retrieveCustomer 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Customer (6 properties), CustomerCreate (5 properties), CustomerList (2 properties), CustomerEnvelope (1 property). Each schema is shown below with its type and property counts.

CustomerEnvelope
object
1 property
CustomerList
object
2 properties
Customer
object
6 properties
CustomerCreate
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chargebee-customers-api-openapi.yml Raw ↑

Other APIs Chargebee publishes across the network.

Chargebee Invoices API
Chargebee Items API
Chargebee Orders API
Chargebee Payments API
Chargebee Plans API
Chargebee Quotes API
Chargebee Subscriptions API