Refund Invoice
chargebee.refund_invoice
ActionCRM & salesconnection required
Calls the Chargebee API with the connection's credentials.
Refund a paid invoice in full or in part.
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
5 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 | — | — | — |
refund_amount How much to refund, in the currency's smallest unit (cents). Leave empty to refund everything that was paid. | number | No | — | ≥ 1 | — |
comment An internal note recorded against the invoice in the Chargebee UI. It is never shown to the customer. | string | No | — | ≤ 300 characters | — |
customer_notes A note recorded on the credit note and shown to the customer. | string | No | — | ≤ 2000 characters | — |
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 | — |
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 | — |
credit_note The credit note raised for the refunded amount. | object | — |
{
"credit_note": {},
"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}/refund
See Refund 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.