> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# appmixer.stripe.core.RetrieveInvoice

- Component: `appmixer.stripe.core.RetrieveInvoice`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.stripe 3.1.0](https://connectors.appmixer.com/connector/appmixer.stripe/3.1.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.stripe/3.1.0/component/appmixer.stripe.core.RetrieveInvoice>

Retrieves the details of an existing invoice by its ID.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Invoice Id (`invoiceId`) | text | The identifier of the Invoice to retrieve. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Id (`id`) | string | - |
| Object (`object`) | string | - |
| Account Country (`account_country`) | string | - |
| Account Name (`account_name`) | string | - |
| Amount Due (`amount_due`) | number | - |
| Amount Paid (`amount_paid`) | number | - |
| Amount Overpaid (`amount_overpaid`) | number | - |
| Amount Remaining (`amount_remaining`) | number | - |
| Amount Shipping (`amount_shipping`) | number | - |
| Application (`application`) | string | - |
| Attempt Count (`attempt_count`) | number | - |
| Attempted (`attempted`) | boolean | - |
| Auto Advance (`auto_advance`) | boolean | - |
| Automatic Tax (`automatic_tax`) | object | - |
| Billing Reason (`billing_reason`) | string | - |
| Collection Method (`collection_method`) | string | - |
| Created (`created`) | number | - |
| Currency (`currency`) | string | - |
| Custom Fields (`custom_fields`) | string | - |
| Customer (`customer`) | string | - |
| Customer Address (`customer_address`) | string | - |
| Customer Email (`customer_email`) | string | - |
| Customer Name (`customer_name`) | string | - |
| Customer Phone (`customer_phone`) | string | - |
| Customer Shipping (`customer_shipping`) | string | - |
| Customer Tax Exempt (`customer_tax_exempt`) | string | - |
| Default Payment Method (`default_payment_method`) | string | - |
| Default Source (`default_source`) | string | - |
| Description (`description`) | string | - |
| Due Date (`due_date`) | string | - |
| Ending Balance (`ending_balance`) | string | - |
| Footer (`footer`) | string | - |
| From Invoice (`from_invoice`) | string | - |
| Hosted Invoice Url (`hosted_invoice_url`) | string | - |
| Invoice Pdf (`invoice_pdf`) | string | - |
| Issuer (`issuer`) | object | - |
| Last Finalization Error (`last_finalization_error`) | string | - |
| Latest Revision (`latest_revision`) | string | - |
| Livemode (`livemode`) | boolean | - |
| Metadata (`metadata`) | object | - |
| Next Payment Attempt (`next_payment_attempt`) | string | - |
| Number (`number`) | string | - |
| On Behalf Of (`on_behalf_of`) | string | - |
| Parent (`parent`) | string | - |
| Payment Settings (`payment_settings`) | object | - |
| Period End (`period_end`) | number | - |
| Period Start (`period_start`) | number | - |
| Post Payment Credit Notes Amount (`post_payment_credit_notes_amount`) | number | - |
| Pre Payment Credit Notes Amount (`pre_payment_credit_notes_amount`) | number | - |
| Receipt Number (`receipt_number`) | string | - |
| Shipping Cost (`shipping_cost`) | string | - |
| Shipping Details (`shipping_details`) | object | - |
| Starting Balance (`starting_balance`) | number | - |
| Statement Descriptor (`statement_descriptor`) | string | - |
| Status (`status`) | string | - |
| Status Transitions (`status_transitions`) | object | - |
| Subtotal (`subtotal`) | number | - |
| Subtotal Excluding Tax (`subtotal_excluding_tax`) | number | - |
| Test Clock (`test_clock`) | string | - |
| Total (`total`) | number | - |
| Total Excluding Tax (`total_excluding_tax`) | number | - |
| Webhooks Delivered At (`webhooks_delivered_at`) | number | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.stripe.core.RetrieveInvoice",
  "author": "Appmixer <info@appmixer.com>",
  "description": "Retrieves the details of an existing invoice by its ID.",
  "version": "1.0.0",
  "private": false,
  "auth": {
    "service": "appmixer:stripe"
  },
  "quota": {
    "manager": "appmixer:stripe",
    "resources": "requests"
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "invoiceId": {
            "type": "string"
          }
        },
        "required": [
          "invoiceId"
        ]
      },
      "inspector": {
        "inputs": {
          "invoiceId": {
            "type": "text",
            "tooltip": "The identifier of the Invoice to retrieve.",
            "label": "Invoice Id",
            "index": 0
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "options": [
        {
          "label": "Id",
          "value": "id",
          "schema": {
            "type": "string",
            "example": "in_1XYZ789ABC123"
          }
        },
        {
          "label": "Object",
          "value": "object",
          "schema": {
            "type": "string",
            "example": "invoice"
          }
        },
        {
          "label": "Account Country",
          "value": "account_country",
          "schema": {
            "type": "string",
            "example": "US"
          }
        },
        {
          "label": "Account Name",
          "value": "account_name",
          "schema": {
            "type": "string",
            "example": "Acme Inc."
          }
        },
        {
          "label": "Amount Due",
          "value": "amount_due",
          "schema": {
            "type": "number",
            "example": 14900
          }
        },
        {
          "label": "Amount Paid",
          "value": "amount_paid",
          "schema": {
            "type": "number",
            "example": 14900
          }
        },
        {
          "label": "Amount Overpaid",
          "value": "amount_overpaid",
          "schema": {
            "type": "number",
            "example": 0
          }
        },
        {
          "label": "Amount Remaining",
          "value": "amount_remaining",
          "schema": {
            "type": "number",
            "example": 0
          }
        },
        {
          "label": "Amount Shipping",
          "value": "amount_shipping",
          "schema": {
            "type": "number",
            "example": 0
          }
        },
        {
          "label": "Application",
          "value": "application",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Attempt Count",
          "value": "attempt_count",
          "schema": {
            "type": "number",
            "example": 1
          }
        },
        {
          "label": "Attempted",
          "value": "attempted",
          "schema": {
            "type": "boolean",
            "example": true
          }
        },
        {
          "label": "Auto Advance",
          "value": "auto_advance",
          "schema": {
            "type": "boolean",
            "example": false
          }
        },
        {
          "label": "Automatic Tax",
          "value": "automatic_tax",
          "schema": {
            "type": "object",
            "properties": {
              "enabled": {
                "type": "boolean",
                "title": "Automatic Tax.Enabled"
              },
              "liability": {
                "type": "string",
                "title": "Automatic Tax.Liability"
              },
              "status": {
                "type": "string",
                "title": "Automatic Tax.Status"
              }
            },
            "example": {
              "enabled": false,
              "liability": null,
              "status": null
            }
          }
        },
        {
          "label": "Billing Reason",
          "value": "billing_reason",
          "schema": {
            "type": "string",
            "example": "subscription_cycle"
          }
        },
        {
          "label": "Collection Method",
          "value": "collection_method",
          "schema": {
            "type": "string",
            "example": "charge_automatically"
          }
        },
        {
          "label": "Created",
          "value": "created",
          "schema": {
            "type": "number",
            "example": 1736870400
          }
        },
        {
          "label": "Currency",
          "value": "currency",
          "schema": {
            "type": "string",
            "example": "usd"
          }
        },
        {
          "label": "Custom Fields",
          "value": "custom_fields",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Customer",
          "value": "customer",
          "schema": {
            "type": "string",
            "example": "cus_GHI789JKL012"
          }
        },
        {
          "label": "Customer Address",
          "value": "customer_address",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Customer Email",
          "value": "customer_email",
          "schema": {
            "type": "string",
            "example": "finance@company.com"
          }
        },
        {
          "label": "Customer Name",
          "value": "customer_name",
          "schema": {
            "type": "string",
            "example": "Globex Corporation"
          }
        },
        {
          "label": "Customer Phone",
          "value": "customer_phone",
          "schema": {
            "type": "string",
            "example": "+14155550100"
          }
        },
        {
          "label": "Customer Shipping",
          "value": "customer_shipping",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Customer Tax Exempt",
          "value": "customer_tax_exempt",
          "schema": {
            "type": "string",
            "example": "none"
          }
        },
        {
          "label": "Default Payment Method",
          "value": "default_payment_method",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Default Source",
          "value": "default_source",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Description",
          "value": "description",
          "schema": {
            "type": "string",
            "example": "Monthly subscription"
          }
        },
        {
          "label": "Due Date",
          "value": "due_date",
          "schema": {
            "type": "string",
            "example": 1739462400
          }
        },
        {
          "label": "Ending Balance",
          "value": "ending_balance",
          "schema": {
            "type": "string",
            "example": "0"
          }
        },
        {
          "label": "Footer",
          "value": "footer",
          "schema": {
            "type": "string",
            "example": "Thank you for your business."
          }
        },
        {
          "label": "From Invoice",
          "value": "from_invoice",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Hosted Invoice Url",
          "value": "hosted_invoice_url",
          "schema": {
            "type": "string",
            "example": "https://invoice.stripe.com/i/acct_1M2JTkLkdIwHu7ix/in_1XYZ789ABC123"
          }
        },
        {
          "label": "Invoice Pdf",
          "value": "invoice_pdf",
          "schema": {
            "type": "string",
            "example": "https://pay.stripe.com/invoice/acct_1M2JTkLkdIwHu7ix/in_1XYZ789ABC123/pdf"
          }
        },
        {
          "label": "Issuer",
          "value": "issuer",
          "schema": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "title": "Issuer.Type"
              }
            },
            "example": {
              "type": "self"
            }
          }
        },
        {
          "label": "Last Finalization Error",
          "value": "last_finalization_error",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Latest Revision",
          "value": "latest_revision",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Livemode",
          "value": "livemode",
          "schema": {
            "type": "boolean",
            "example": false
          }
        },
        {
          "label": "Metadata",
          "value": "metadata",
          "schema": {
            "type": "object",
            "properties": {},
            "example": {
              "order_id": "6735"
            }
          }
        },
        {
          "label": "Next Payment Attempt",
          "value": "next_payment_attempt",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Number",
          "value": "number",
          "schema": {
            "type": "string",
            "example": "INV-2026-0035"
          }
        },
        {
          "label": "On Behalf Of",
          "value": "on_behalf_of",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Parent",
          "value": "parent",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Payment Settings",
          "value": "payment_settings",
          "schema": {
            "type": "object",
            "properties": {
              "default_mandate": {
                "type": "string",
                "title": "Payment Settings.Default Mandate"
              },
              "payment_method_options": {
                "type": "string",
                "title": "Payment Settings.Payment Method Options"
              },
              "payment_method_types": {
                "type": "string",
                "title": "Payment Settings.Payment Method Types"
              }
            },
            "example": {
              "default_mandate": null,
              "payment_method_options": null,
              "payment_method_types": null
            }
          }
        },
        {
          "label": "Period End",
          "value": "period_end",
          "schema": {
            "type": "number",
            "example": 1733011200
          }
        },
        {
          "label": "Period Start",
          "value": "period_start",
          "schema": {
            "type": "number",
            "example": 1730419200
          }
        },
        {
          "label": "Post Payment Credit Notes Amount",
          "value": "post_payment_credit_notes_amount",
          "schema": {
            "type": "number",
            "example": 0
          }
        },
        {
          "label": "Pre Payment Credit Notes Amount",
          "value": "pre_payment_credit_notes_amount",
          "schema": {
            "type": "number",
            "example": 0
          }
        },
        {
          "label": "Receipt Number",
          "value": "receipt_number",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Shipping Cost",
          "value": "shipping_cost",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Shipping Details",
          "value": "shipping_details",
          "schema": {
            "type": "object",
            "properties": {
              "address": {
                "type": "object",
                "title": "Address",
                "properties": {
                  "city": {
                    "type": "string",
                    "title": "City"
                  },
                  "country": {
                    "type": "string",
                    "title": "Country"
                  },
                  "line1": {
                    "type": "string",
                    "title": "Line1"
                  },
                  "line2": {
                    "type": "string",
                    "title": "Line2"
                  },
                  "postal_code": {
                    "type": "string",
                    "title": "PostalCode"
                  },
                  "state": {
                    "type": "string",
                    "title": "State"
                  }
                }
              },
              "name": {
                "type": "string",
                "title": "Name"
              },
              "phone": {
                "type": "string",
                "title": "Phone"
              }
            },
            "example": {
              "address": {
                "city": "San Francisco",
                "country": "US",
                "line1": "510 Townsend St",
                "line2": "Suite 200",
                "postal_code": "94103",
                "state": "CA"
              },
              "name": "Globex Corporation",
              "phone": "+14155550100"
            }
          }
        },
        {
          "label": "Starting Balance",
          "value": "starting_balance",
          "schema": {
            "type": "number",
            "example": 0
          }
        },
        {
          "label": "Statement Descriptor",
          "value": "statement_descriptor",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Status",
          "value": "status",
          "schema": {
            "type": "string",
            "example": "paid"
          }
        },
        {
          "label": "Status Transitions",
          "value": "status_transitions",
          "schema": {
            "type": "object",
            "properties": {
              "finalized_at": {
                "type": "string",
                "title": "Status Transitions.Finalized At"
              },
              "marked_uncollectible_at": {
                "type": "string",
                "title": "Status Transitions.Marked Uncollectible At"
              },
              "paid_at": {
                "type": "string",
                "title": "Status Transitions.Paid At"
              },
              "voided_at": {
                "type": "string",
                "title": "Status Transitions.Voided At"
              }
            },
            "example": {
              "finalized_at": "1733014800",
              "marked_uncollectible_at": null,
              "paid_at": "1733018400",
              "voided_at": null
            }
          }
        },
        {
          "label": "Subtotal",
          "value": "subtotal",
          "schema": {
            "type": "number",
            "example": 14900
          }
        },
        {
          "label": "Subtotal Excluding Tax",
          "value": "subtotal_excluding_tax",
          "schema": {
            "type": "number",
            "example": 14900
          }
        },
        {
          "label": "Test Clock",
          "value": "test_clock",
          "schema": {
            "type": "string",
            "example": null
          }
        },
        {
          "label": "Total",
          "value": "total",
          "schema": {
            "type": "number",
            "example": 14900
          }
        },
        {
          "label": "Total Excluding Tax",
          "value": "total_excluding_tax",
          "schema": {
            "type": "number",
            "example": 14900
          }
        },
        {
          "label": "Webhooks Delivered At",
          "value": "webhooks_delivered_at",
          "schema": {
            "type": "number",
            "example": 1733011260
          }
        }
      ]
    }
  ],
  "icon": "(data URI omitted)"
}
```
