Actions35
- Payment Actions
- Customer Actions
- Invoice Actions
- Product Actions
- Price Actions
- Subscription Actions
- Payout Actions
- Balance Actions
Invoice → Create an Invoice
AI-generatedSummary
Create a SouthPay invoice for a selected customer, with a currency and any configured line items. Optionally include a due date, description, and metadata; the operation sends the invoice to SouthPay and returns its response.
Inputs
- Customer (required) — Choose a customer from the searchable list or enter a customer ID.
- Currency (required) — Invoice currency, selected from SouthPay’s available currencies; defaults to USD.
- Line Items — Add zero or more items, each with a description, quantity (defaults to 1), and unit amount in cents (defaults to 0).
- Due At — Optional invoice due date and time.
- Description — Optional invoice description.
- Metadata — Optional JSON object of string values.
Output shape
One SouthPay API response object per input item.
The request creates an invoice with the selected customer ID, currency, and line items; optional due date, description, and metadata are included only when provided. With Continue On Fail enabled, failures produce an item containing an error message.
Examples
Example 1: Add a variable quantity of items to an invoice
Select a SouthPay customer, choose the invoice currency, then add each item with its description, quantity, and unit amount in cents. Optionally set a due date, invoice description, or metadata.
Example 2: Create an invoice associated with an existing customer ID
Switch Customer to By ID and provide the customer ID, then configure the currency and any line items.