Chargebee Action Block
What it does: Manages customers, subscriptions and invoices in your Chargebee billing site, and generates hosted checkout / self-serve portal links.
💳
In simple terms: Sign a customer up for a plan, change or cancel their subscription, chase an unpaid invoice, or hand them a checkout link — all from inside a workflow.
Credentials
| Field | Description |
|---|---|
| Site | Your Chargebee subdomain — the acme-test in acme-test.chargebee.com. A full URL is accepted and trimmed automatically. |
| API Key | A full-access API key from Admin Console → Settings → Configure Chargebee → API Keys. Sent as HTTP Basic auth. |
Actions
| Action | What it does | Output |
|---|---|---|
| Create / Update Customer | Creates or updates a customer with email, name, company, phone, billing address and metadata | customer object |
| Get Customer | Fetches one customer by id | customer object |
| List Customers | Lists customers, optionally filtered by email | list, next_offset, has_more |
| Delete Customer | Permanently deletes a customer | customer object |
| Create Subscription | Subscribes a customer to an item price (subscription_for_items) with quantity, trial end and coupons | subscription, customer, invoice |
| Get / List Subscriptions | Fetches one subscription, or lists them filtered by customer and status | Subscription object / paged list |
| Update Subscription | Switches plan, changes quantity or applies coupons (update_for_items) | subscription |
| Cancel Subscription | Cancels immediately, or at the end of the term with End Of Term = true | subscription |
| Reactivate / Pause / Resume Subscription | Lifecycle controls, with pause_option / resume_option | subscription |
| List / Get Invoice | Lists invoices by customer, subscription or status, or fetches one | Paged list / invoice |
| Collect Invoice Payment | Retries collection on an unpaid invoice | invoice, transaction |
| Void Invoice | Voids an invoice | invoice |
| Invoice PDF | Generates a time-limited PDF download link | url, valid_till |
| List Items / List Item Prices | Reads your product catalog | Paged list |
| Create Checkout URL | Hosted checkout page for an item price | url (send this to the customer) |
| Create Portal Session | Self-serve billing portal session for a customer | url (the portal access_url) |
Tips
- Pagination: list actions return
next_offset. Feed it into the Offset field of the next call and stop whenhas_moreisfalse. - Item price ids look like
pro-plan-USD-Monthly. Use List Item Prices once to discover them. - Trial End takes a Unix timestamp in seconds;
0starts billing immediately with no trial. - Billing Address and Metadata are JSON objects — the block flattens the address into Chargebee's
billing_address[...]form fields for you. - Errors surface Chargebee's
api_error_codealongside the HTTP status, e.g.Chargebee error (404) [resource_not_found]: ....