Chargebee
Manage Chargebee subscriptions, customers, invoices, and billing
Integrates Chargebee into your workflow. List and retrieve subscriptions and customers, manage invoices, and cancel subscriptions. Ideal for automating subscription billing workflows and SaaS revenue operations.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
site | string | Yes | Chargebee site name (e.g., mycompany from mycompany.chargebee.com) |
limit | number | No | Maximum number of subscriptions to return (default 10, max 100) |
customerId | string | No | Filter by customer ID |
status | string | No | Filter by status (active, cancelled, in_trial, paused, non_renewing) |
| Parameter | Type | Description |
|---|
subscriptions | array | List of Chargebee subscriptions |
↳ id | string | Subscription ID |
↳ plan_id | string | Plan ID |
↳ status | string | Subscription status |
↳ customer_id | string | Customer ID |
metadata | json | Pagination metadata |
↳ count | number | Number of subscriptions returned |
↳ nextOffset | string | Offset for next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
site | string | Yes | Chargebee site name |
subscriptionId | string | Yes | Subscription ID to retrieve |
| Parameter | Type | Description |
|---|
subscription | json | Chargebee subscription object |
↳ id | string | Subscription ID |
↳ plan_id | string | Plan ID |
↳ status | string | Subscription status |
↳ current_term_end | number | Current term end timestamp |
customer | json | Associated customer object |
↳ id | string | Customer ID |
↳ email | string | Customer email |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
site | string | Yes | Chargebee site name |
limit | number | No | Maximum number of customers to return (default 10) |
email | string | No | Filter by customer email |
| Parameter | Type | Description |
|---|
customers | array | List of Chargebee customers |
↳ id | string | Customer ID |
↳ email | string | Customer email |
↳ company | string | Company name |
metadata | json | Pagination metadata |
↳ count | number | Number of customers returned |
↳ nextOffset | string | Offset for next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
site | string | Yes | Chargebee site name |
limit | number | No | Maximum number of invoices to return (default 10) |
customerId | string | No | Filter by customer ID |
status | string | No | Filter by status (paid, posted, payment_due, not_paid, voided) |
| Parameter | Type | Description |
|---|
invoices | array | List of Chargebee invoices |
↳ id | string | Invoice ID |
↳ status | string | Invoice status |
↳ total | number | Invoice total |
↳ amount_due | number | Amount due |
↳ currency_code | string | Currency code |
metadata | json | Pagination metadata |
↳ count | number | Number of invoices returned |
↳ nextOffset | string | Offset for next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
site | string | Yes | Chargebee site name |
subscriptionId | string | Yes | Subscription ID to cancel |
endOfTerm | boolean | No | If true, cancels at end of current term; if false, cancels immediately |
| Parameter | Type | Description |
|---|
subscription | json | Cancelled subscription object |
↳ id | string | Subscription ID |
↳ status | string | Updated subscription status |
↳ cancel_at | number | Cancellation timestamp |
↳ cancelled_at | number | Actual cancellation timestamp |
metadata | json | Cancellation metadata |
↳ subscriptionId | string | Subscription ID |
