stripe.invoices.get_invoice ​
Get a Stripe invoice with its hosted URL and PDF link
Read one invoice. hosted_invoice_url and invoice_pdf are safe to hand to the payer directly — Stripe hosts both.
Acts on the CUSTOMER'S OWN Stripe account, authenticated via the org-scoped Stripe connection selected by cloud_connection_uuid.
Inputs:
- cloud_connection_uuid: Org-scoped Stripe connection (customer's own account).
- invoice_id: Stripe invoice ID (in_...).
Outputs (terminal state_data):
- invoice_id: str
- status: str
- customer_id: str
- subscription_id: str
- amount_due: int
- amount_paid: int
- currency: str
- hosted_invoice_url: str
- invoice_pdf: str
- number: str
Connection required: cloud_connection_uuid — the organization's own Stripe account credentials; there is no platform-key fallback.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-stripe |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | Yes | — | Org-scoped Stripe connection (customer's own account) |
invoice_id | string | Yes | — | Stripe invoice ID (in_...) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
invoice_id | string | No | — | — |
status | string | No | — | — |
customer_id | string | No | — | — |
subscription_id | string | No | — | — |
amount_due | integer | No | — | — |
amount_paid | integer | No | — | — |
currency | string | No | — | — |
hosted_invoice_url | string | No | — | — |
invoice_pdf | string | No | — | — |
number | string | No | — | — |
cloud_connection_uuid | uuid | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_layer | integer | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "stripe.invoices.get_invoice",
"initial_data": {
"cloud_connection_uuid": "value",
"invoice_id": "value"
}
}