Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-stripe
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
cloud_connection_uuiduuidYes—Org-scoped Stripe connection (customer's own account)
invoice_idstringYes—Stripe invoice ID (in_...)

Output Schema ​

FieldTypeRequiredDefaultDescription
invoice_idstringNo——
statusstringNo——
customer_idstringNo——
subscription_idstringNo——
amount_dueintegerNo——
amount_paidintegerNo——
currencystringNo——
hosted_invoice_urlstringNo——
invoice_pdfstringNo——
numberstringNo——
cloud_connection_uuiduuidNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
errorstringNo——
error_typestringNo——
failed_layerintegerNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

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"
  }
}