Create Invoice
chargebee.create_invoice
ActionCRM & salesconnection required
Calls the Chargebee API with the connection's credentials.
Raise an invoice for charge items and one-time charges.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Chargebee
- Secret shape
- the site API key: the raw string, {"api_key": "…"}, or the HTTP Basic pair {"username": "<api key>", "password": ""}
- Config it needs
- site, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
customer_id The customer to invoice. Give this or a subscription_id. | string | No | — | ≤ 50 characters | — |
subscription_id The subscription to invoice against. Give this or a customer_id. | string | No | — | ≤ 50 characters | — |
item_prices Charge item prices to bill, as a JSON array of {"item_price_id": "ssl-charge-USD", "unit_price": 2000} objects. | array | No | — | array of object | — |
charges Ad-hoc one-time charges, as a JSON array of {"amount": 1000, "description": "Setup fee"} objects. | array | No | — | array of object | — |
currency_code The three-letter currency code; required when the site has multi-currency enabled. | string | No | — | ≤ 3 characters | — |
extra Any other parameter documented for this endpoint, merged into the request body. Nested objects and arrays are form-encoded the way Chargebee documents them, e.g. {"billing_address": {"city": "Walnut"}}. | object | No | — | — | {"billing_address":{"city":"Walnut"}} |
idempotency_key A unique value sent as 'chargebee-idempotency-key' so a retry inside Chargebee's 30-minute window replays the first response instead of charging or creating twice. | string | No | — | ≤ 100 characters | — |
- At least one of customer_id, subscription_id must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"extra": {
"billing_address": {
"city": "Walnut"
}
}
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
invoice The invoice resource as Chargebee returned it. | object | — |
{
"invoice": {}
}Notes
- The Chargebee site and API key come from the connection; every path below is relative to https://<site>.chargebee.com/api/v2.
- POST /invoices/create_for_charge_items_and_charges
See Create Invoice run in a workflow.
In a technical demo we add the Chargebee connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.