List Customer Credit Balances

paddle.list_credit_balances
ActionBusiness appsconnection required

Calls the Paddle API with the connection's credentials.

Read a customer's available, reserved and used credit per currency.

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Paddle
Secret shape
the Paddle API key (pdl_…), or {"api_key": "…"}
Config it needs
environment, base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
customer_id
The customer id, prefixed ctm_.
stringYes———
currency_code
Comma-separated three-letter currencies to limit the answer to.
stringNo———

Output

One shape.

result

FieldTypeExample
items
One balance record per currency, as Paddle returned it.
array—
count
How many currency balances came back.
number—
customer_id
The customer the balances belong to.
string—
{
  "count": 0,
  "customer_id": "",
  "items": []
}

Notes

  • Paddle does not paginate this endpoint, so every currency the customer holds credit in is in one answer.

See List Customer Credit Balances run in a workflow.

In a technical demo we add the Paddle connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.