Chargebee API
12 endpoints for Chargebee, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.
- Base URL
- https://cotlet.dev/api/v1/chargebee
- Connects with
- Your own Chargebee Billing login (a user whose role allows editing subscriptions and creating credit notes)
- Integration page
- Chargebee
Read (7)
Return data and change nothing in the account.
| Endpoint | Description |
|---|---|
| GET | Customers matching an email, company or name. |
| GET | One customer with tax status, credits and payment collection setting. |
| GET | Subscriptions filtered by customer, status, plan or renewal date, newest first. |
| GET | One subscription with its items, coupons and any scheduled change. |
| GET | Invoices filtered by customer, subscription, status or date, newest first. |
| GET | One invoice with line items, payments and credits applied. |
| GET | Credit notes for a customer or an invoice, newest first. |
Write (5)
Change the account. Calls marked Confirm wait for the user to approve them.
| Endpoint | Description |
|---|---|
| PATCH | Move a subscription to another plan or quantity, now or at renewal. |
| POST | Cancel a subscription now, at the end of the term or on a date. |
| POST | Credit all or part of an invoice with a refundable or adjustment credit note. |
| POST | Add a coupon to a subscription. |
| POST | Record an offline payment, such as a bank transfer, on an open invoice. |