Get Invoice

stripe.get_invoice
ActionBusiness appsconnection required

Calls the Stripe API with the connection's secret key.

Retrieve one Stripe invoice by its id.

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Stripe
Secret shape
the Stripe secret key (sk_...)
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.

FieldTypeRequiredDefaultConstraintsExample
invoice_id
The invoice to act on (in_...). Supports {{ }} expressions.
stringYes——in_1MtHbELkdIwHu7ixl4OzzPMv

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "invoice_id": "in_1MtHbELkdIwHu7ixl4OzzPMv"
}

Output

One shape.

result

FieldTypeExample
id
The invoice id (in_...).
string—
number
The customer-facing invoice number, once finalised.
string—
status
One of draft, open, paid, uncollectible or void.
string—
customer
The customer being billed.
string—
currency
Three-letter lowercase ISO currency code.
string—
subtotal
Total before discounts and tax, in the minor unit.
number—
total
Total after discounts and tax, in the minor unit.
number—
amount_due
Amount due on this invoice, in the minor unit.
number—
amount_paid
Amount paid so far, in the minor unit.
number—
amount_remaining
Amount still owed, in the minor unit.
number—
collection_method
charge_automatically or send_invoice.
string—
due_date
When payment is due, Unix seconds, or null.
number—
hosted_invoice_url
Stripe-hosted page where the customer can pay.
string—
invoice_pdf
Link to the invoice PDF, once finalised.
string—
created
Creation time, as a Unix timestamp in seconds.
number—
metadata
The key/value pairs stored on the invoice.
object—
{
  "amount_due": 0,
  "amount_paid": 0,
  "amount_remaining": 0,
  "collection_method": "",
  "created": 0,
  "currency": "",
  "customer": "",
  "due_date": 0,
  "hosted_invoice_url": "",
  "id": "",
  "invoice_pdf": "",
  "metadata": {},
  "number": "",
  "status": "",
  "subtotal": 0,
  "total": 0
}

See Get Invoice run in a workflow.

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