Actions84
- Affiliate Actions
- Checkout Actions
- Customer Actions
- Discount Actions
- Discount Redemption Actions
- File Actions
- License Key Actions
- License Key Instance Actions
- Order Actions
- Order Item Actions
- Price Actions
- Product Actions
- Store Actions
- Subscription Actions
- Subscription Invoice Actions
- Subscription Item Actions
- Usage Record Actions
- User Actions
- Variant Actions
- Webhook Actions
Order → Generate Invoice
AI-generatedSummary
Generate an invoice for the specified order using the supplied billing details. Optionally download the invoice as a PDF binary and simplify the returned JSON:API response.
Inputs
- Order ID (required) — ID of the order to generate an invoice for.
- Invoice Name (required) — Full name to include on the invoice.
- Invoice Address (required) — Street address to include on the invoice.
- Invoice City (required) — City to include on the invoice.
- Invoice Zip Code (required) — Postal or ZIP code to include on the invoice.
- Invoice Country (required) — Country code in ISO 3166-1 alpha-2 format, such as US or GB.
- Download PDF — When enabled, download the generated invoice as a PDF binary file.
- Binary Property — Binary property name for the PDF; shown when Download PDF is enabled. Defaults to data.
- Invoice Options — Optional invoice details: State (required for US and CA), Notes, and Locale (ISO 639 language code).
- Simplify — Defaults to true; flattens JSON:API attributes into the top-level response. Disable to return the raw JSON:API format.
- Retry Options — Configure retry behavior for failed API requests: Max Retries (0–10, default 3) and Initial Delay (100–30000 ms, default 1000; delay doubles on each retry).
Output shape
Invoice API response for the order; optionally includes the downloaded PDF as binary data.
With Simplify enabled, JSON:API attributes are flattened to the top level; otherwise the raw JSON:API structure is returned. When PDF download is enabled, the PDF is written to the configured binary property.