younifyd
Menu

Chargebee

Manage Chargebee billing — customers, payment sources, subscriptions and their lifecycle, invoices, credit notes, transactions, items, coupons, and estimates. Covers Basic auth, the site base URL, the form-encoded-body requirement, and the list/offset pagination.

Browse 180 Chargebee actions Chargebee API
On this page

Connecting Chargebee

Every action needs a Chargebee connection configured with HTTP Basic authentication — your Chargebee API key as the username, an empty password.

Set the Base URL to your site. The spec's server is a template; on every action use the Base URL field to enter https://<your-site>.chargebee.com/api/v2 (use .chargebee.com for live, -test.chargebee.com for test).

Every action, with its parameters and response fields, is listed in the action reference.

What's covered

Actions are generated from the Chargebee API v2 (Product Catalog 2.0) spec, narrowed to the core billing objects: customers and payment sources, subscriptions and their lifecycle (pause, resume, cancel, reactivate, …), invoices, credit notes, transactions, items, item prices, coupons, addresses, usages, and estimates/quotes. Names come from the operation ids and read like "List customers", "Retrieve a customer", "Update a subscription", "Void an invoice". Path parameters (customer-id, subscription-id, invoice-id, …) are dedicated fields. Other resources (events, exports, hosted pages, plans, gifts, orders, payment intents, webhook endpoints, …) are reached with the Generic GET / POST / PUT / PATCH / DELETE Request actions, whose path is relative to the Base URL (e.g. /events).

Request bodies are form-encoded, not JSON

Chargebee's API v2 takes application/x-www-form-urlencoded request bodies with bracket notation for nested and array fields (e.g. subscription_items[item_price_id][0]=basic-USD-monthly). The connector's structured request-body field sends JSON, which Chargebee rejects — so for every POST action (and generic write requests):

  1. Turn on Override Request Body.
  2. Add an Additional Header Content-Type = application/x-www-form-urlencoded.
  3. Put the body in Request Body (Raw) as key=value pairs joined by &, using Chargebee's bracket notation, e.g.
    text
    first_name=Ada&last_name=Lovelace&email=ada@example.com&billing_address[line1]=1+Main+St&billing_address[city]=London
    

GET actions (list / retrieve) need none of this and work directly.

Reading the response

Every action's result is at {{<stepReference>.response...}} (see Step Reference): {{<stepReference>.response.status}}, {{<stepReference>.response.headers.<name>}}, and {{<stepReference>.response.data...}} for the body.

Chargebee wraps a single resource in a key named after it, often alongside related resources: a "Retrieve a customer" step (reference retrieve_a_customer) resolves fields at {{retrieve_a_customer.response.data.customer.email}}, and its card at {{retrieve_a_customer.response.data.card}}. A "Create a subscription" returns subscription, customer, and invoice together under data.

Lists return {{<stepReference>.response.data.list}} — an array where each entry is itself { customer: {...} } etc. — plus {{<stepReference>.response.data.next_offset}}; pass that back as the offset query parameter for the next page. List filters use Chargebee's operator syntax as query parameters, e.g. email[is] = ada@example.com, status[in] = ["active","non_renewing"] — add them via Additional Query Parameters.

A non-2xx response does not fail the step — Chargebee's error body ({{<stepReference>.response.data.message}}, {{<stepReference>.response.data.api_error_code}}, {{<stepReference>.response.data.error_code}}) is returned with the real status.

Your first call

  1. Add a Chargebee step and choose List customers; name it listCustomers.
  2. Set the Base URL to your site (see above).
  3. Optionally add Additional Query Parameters email[is] = ada@example.com.
  4. Run it and read {{listCustomers.response.data.list[0].customer.id}} and {{listCustomers.response.data.next_offset}}.

Also applies here

Step Name

What it's for

Every step in a workflow gets a name — either one you set or a default based on the connector and action (e.g. "Get Order Details", "Send Welcome Email"). It's shown throughout the UI and in your execution history, and it's also the source for the step's Reference — a camelCase identifier auto-generated from the name (e.g. "Get Order Details" → getOrderDetails) — which is what you actually use in {{...}} expressions to read this step's output from later steps. See Step Reference.

Rules

  • Must be at least 2 characters, and 50 characters or fewer.
  • Must be unique within the workflow — reusing a name that's already taken will be rejected, with a suggested alternative (e.g. "Get Order Details 2").
  • Can't be empty.

Tips

  • Prefer a descriptive, human-readable name over a generic one — "Get Order Details" is easier to work with later than "HTTP Request 2", especially once a workflow has a dozen steps.
  • Renaming a step updates every reference to it elsewhere in the workflow automatically.

Step Reference

Syntax

Any input field can reference earlier data using {{expression}}. The expression is evaluated as JSONata — so simple dot-paths and more advanced queries (filters, functions) both work.

Referencing a step's output

Use the step's Reference — a camelCase identifier auto-generated from its Name (e.g. "Get Order Details" → getOrderDetails), shown read-only wherever the step's fields are configured — followed by the field path. Elsewhere in these docs this general pattern is written as {{<stepReference>.field.path}}:

text
{{getOrderDetails.response.data.id}}
{{getOrderDetails.response.status}}

The raw display name won't work here even though it's what you see in the UI — {{Get Order Details.response.data.id}} isn't valid, since a bare name containing spaces isn't a single JSONata identifier. Always use the camelCase Reference.

You can also reference steps by position instead of by reference:

text
{{steps[0].response.data.id}}

Referencing trigger data

text
{{trigger.headers.authorization}}
{{trigger.body.customerId}}
{{trigger.query.page}}
{{trigger.params.orderId}}
{{trigger.method}}
{{trigger.path}}

Referencing workflow variables

text
{{variables.myVariable}}

See Variables for the full list of variable types and more examples, including connection-type variables.

Referencing runtime variables

A separate, mutable namespace written by the Variable connector while a run is in progress — not the same as the workflow-level variables above:

text
{{runtimeVariables.myVariable}}

Notes

  • If an expression can't be resolved (a typo in a step name, a field that doesn't exist), it resolves to an empty string rather than failing the workflow — check your execution history if a value comes through blank.
  • Object values are automatically JSON-stringified when interpolated into a string field.

Execution Settings

Fire-and-forget

When enabled, the workflow doesn't wait for this step to complete before moving to the next one. Use it for steps whose result nothing downstream depends on — logging, analytics, notifications — so they don't add latency to the steps that matter.

Continue on error

When enabled, a failure in this step doesn't stop the workflow — execution continues to the next step. The failure is still recorded in the execution history; this just controls whether it's fatal.

Combine the two for steps that are genuinely optional to the outcome: fire-and-forget so they don't add latency, continue-on-error so a failure in them (e.g. an analytics endpoint being briefly down) doesn't take down an otherwise-successful workflow run.

Caching

What it does

When enabled, a step's result is cached for a configurable TTL (time-to-live, in seconds). If the step runs again with the same effective cache key before the TTL expires, the cached result is returned instead of re-running the step.

Configuring it

  • Enabled — turn caching on or off for this step.
  • TTL — how long (in seconds) a cached result stays valid.
  • Cache key template — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same call". By default this is based on the step's resolved input; a custom template lets you cache more narrowly or broadly than that.

When to use it

Good candidates are steps that call something slow or rate-limited but return the same answer for the same input within a short window — a lookup against a rarely-changing external system, for example. Skip it for steps whose result must always be fresh (anything involving live inventory, pricing, or payment state).

Locking

What it does

When enabled, only one execution of this step (for a given lock key) can run at a time. If a second execution tries to run the same step while a lock is held, it waits until the lock is released or the hold period elapses.

Configuring it

  • Enabled — turn locking on or off for this step.
  • Lock key — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same resource". By default the lock is scoped to the step itself; a custom key lets you lock per-customer, per-order, or any other identifier that needs serialized access.
  • Period — how long (in seconds) the lock is held before it's automatically released, in case an execution doesn't complete normally.

When to use it

Use it whenever concurrent executions could race on the same resource — e.g. two workflow runs both trying to update the same order's status at once. A lock key scoped to the order id ensures only one of them proceeds at a time.

Was this page helpful?

Last updated 9 October 2026