Collect Invoice Payment
chargebee.collect_invoice_payment
ActionCRM & salesconnection required
Calls the Chargebee API with the connection's credentials.
Charge a payment source to settle an outstanding invoice.
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
6 fields, 1 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 |
|---|---|---|---|---|---|
invoice_id The Chargebee invoice id. | string | Yes | — | — | — |
amount How much to collect, in the currency's smallest unit (cents). Leave empty to collect the whole amount due. | number | No | — | ≥ 1 | — |
payment_source_id The stored payment source to charge. Leave empty to use the customer's primary one. | string | No | — | ≤ 40 characters | — |
comment An internal note recorded against the invoice in the Chargebee UI. It is never shown to the customer. | string | No | — | ≤ 300 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 | — |
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 | — |
transaction The payment Chargebee attempted or recorded; read its 'status' before treating the invoice as settled. | object | — |
{
"invoice": {},
"transaction": {}
}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/{invoice-id}/collect_payment
See Collect Invoice Payment 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.