Get Payment Method Update Transaction
paddle.get_payment_method_transaction
ActionBusiness appsconnection required
Calls the Paddle API with the connection's credentials.
Get the transaction whose checkout lets a customer replace their payment method.
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
1 field, 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 |
|---|---|---|---|---|---|
subscription_id The subscription id, prefixed sub_. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The transaction id, prefixed txn_. | string | — |
status draft, ready, billed, paid, completed, canceled or past_due. | string | — |
customer_id The customer being billed, or null on a draft. | string | — |
subscription_id The subscription this transaction belongs to, or null. | string | — |
invoice_number Paddle's invoice number once the transaction is billed. | string | — |
collection_mode automatic when Paddle charges, manual for an invoice. | string | — |
currency_code Three-letter currency this is billed in. | string | — |
origin What created the transaction, such as api or subscription_charge. | string | — |
items The priced line items on the transaction. | array | — |
details Paddle's calculated totals, tax and payout amounts. | object | — |
checkout The hosted checkout, including its url. | object | — |
{
"checkout": {},
"collection_mode": "",
"currency_code": "",
"customer_id": "",
"details": {},
"id": "",
"invoice_number": "",
"items": [],
"origin": "",
"status": "",
"subscription_id": ""
}Notes
- For a past-due subscription Paddle returns the failed transaction; for an active one it creates a zero-amount transaction. Send the customer to checkout.url.
See Get Payment Method Update Transaction 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.