Skip to main content
Welcome to the preview portal — This is an early release of the new Doc Hub experience, with more content coming soon.

Create and Send Invoice

Creating and sending an invoice publishes a payable invoice that is automatically emailed to the customer. In addition to the sent email, you can also share the invoice by sending the customer the redirect URL generated in the invoiceInformation.paymentLink response field.

Itemized Invoices: An invoice can display a single billed amount or list up to 30 billed items. To list the billed items in the invoice, include the items in the request using the line item array fields. An invoice with line items is known as an itemized invoice.

Invoice Numbers: You can assign a unique invoice number in the invoiceInformation.invoiceNumber request field. The invoice number is required for follow-on API requests and tracking. You should store the invoice number in your system so that you can optimally perform the follow-on requests. If you do not include a unique invoice number when creating an invoice, generates a unique invoice number for you in the invoiceInformation.invoiceNumber response field.

Installment Payments: Invoices can be paid in installment payments when these fields and values are included in the request. If an invoice is payable in installments, multiple customers can make payments towards the same invoice.

  • Set invoiceInformation.allowPartialPayments to true.
  • Set orderInformation.amountDetails.minimumPartialAmount to the minimum amount allowed for a partial payment.

Partner Information: If your merchant account is associated with a partner, you can include your partner solution ID (PSID) in the request message for tracking and reporting purposes. To include your PSID, use the clientReferenceInformation.partner.solutionId request field and set its field value to your PSID.

A successfully created and sent invoice is indicated by the SENT status in the status response field. The response message also includes the newly created invoice's details.

Follow-on operations: Update Invoice, Cancel Invoice, Get Invoice Details, Get Invoices

Endpoint

POST /invoicing/v2/invoices

POST /invoicing/v2/invoices

POST /invoicing/v2/invoices

Examples

{  "customerInformation": {    "name": "Test Customer",    "email": "[email protected]"  },  "invoiceInformation": {    "description": "This is a test invoice",    "dueDate": "2019-07-11",    "sendImmediately": true,    "deliveryMode": "email"  },  "orderInformation": {    "amountDetails": {      "totalAmount": "2623.64",      "currency": "USD"    }  }}
{  "_links": {    "self": {      "href": "/v2/invoices/98768",      "method": "GET"    },    "update": {      "href": "/v2/invoices/98768",      "method": "PUT"    },    "deliver": {      "href": "/v2/invoices/98768/delivery",      "method": "POST"    },    "cancel": {      "href": "/v2/invoices/98768/cancelation",      "method": "POST"    }  },  "id": "98768",  "submitTimeUtc": "2024-08-03T00:40:31.143121084Z",  "status": "SENT",  "customerInformation": {    "email": "[email protected]"  },  "processingInformation": {    "requestPhone": false,    "requestShipping": false  },  "invoiceInformation": {    "invoiceNumber": "98768",    "description": "This is a test invoice",    "dueDate": "2019-07-11",    "allowPartialPayments": false,    "paymentLink": "/ebc2/invoicing/payInvoice/2AgCNHLrUtD7hfFR5SVh5DSxISAbFD9zybhUjpxpZuXKLQVyuLttP78uWWLRSSNX?version=v2.1",    "deliveryMode": "Email"  },  "orderInformation": {    "amountDetails": {      "totalAmount": 2623.64,      "currency": "USD",      "balanceAmount": 2623.64    }  }}
{  "customerInformation": {    "name": "Tanya Lee",    "email": "[email protected]"  },  "invoiceInformation": {    "dueDate": "2019-07-11",    "sendImmediately": true,    "deliveryMode": "email"  },  "orderInformation": {    "amountDetails": {      "totalAmount": 293.5,      "currency": "USD"    },    "lineItems": [      {        "productSku": "P653727383",        "productName": "First line item's name",        "unitPrice": 12.05,        "quantity": 20,        "totalAmount": 241      },      {        "productSku": "P987654321",        "productName": "Second line item's name",        "unitPrice": 5.25,        "quantity": 10,        "totalAmount": 52.5      }    ]  }}
{  "_links": {    "self": {      "href": "/v2/invoices/98769",      "method": "GET"    },    "update": {      "href": "/v2/invoices/98769",      "method": "PUT"    },    "deliver": {      "href": "/v2/invoices/98769/delivery",      "method": "POST"    },    "cancel": {      "href": "/v2/invoices/98769/cancelation",      "method": "POST"    }  },  "id": "98769",  "submitTimeUtc": "2024-08-03T00:43:05.320320438Z",  "status": "SENT",  "customerInformation": {    "name": "Tanya Lee",    "email": "[email protected]"  },  "processingInformation": {    "requestPhone": false,    "requestShipping": false  },  "invoiceInformation": {    "invoiceNumber": "98769",    "dueDate": "2019-07-11",    "allowPartialPayments": false,    "paymentLink": "/ebc2/invoicing/payInvoice/XvgrhdaVUbBJb466S9nxqXpp1e2UHoFEUlhye9gtiwgi7gzv5fwqV8YgfP6xep0D?version=v2.1",    "deliveryMode": "Email"  },  "orderInformation": {    "amountDetails": {      "totalAmount": 293.5,      "currency": "USD",      "balanceAmount": 293.5    },    "lineItems": [      {        "productSku": "P653727383",        "productName": "First line item's name",        "unitPrice": 12.05,        "quantity": 20,        "totalAmount": 241      },      {        "productSku": "P987654321",        "productName": "Second line item's name",        "unitPrice": 5.25,        "quantity": 10,        "totalAmount": 52.5      }    ]  }}

Required Fields

Required Fields: Send an Invoice
customerInformation.email string

Customer's email address. The invoice is sent to this address.

customerInformation.name string

Customer's full name as it appears on the invoice.

invoiceInformation.deliveryMode string

Set to email.

invoiceInformation.description string

Customer-facing description of the invoice.

invoiceInformation.dueDate string

The date payment is due. Format: YYYY-MM-DD.

invoiceInformation.sendImmediately boolean

Set to true.

orderInformation.amountDetails.currency string

ISO 4217 three-letter currency code for the invoice.

orderInformation.amountDetails.totalAmount string

The total charge amount for the invoice, as a decimal string.

Required Fields: Send an Email Invoice with Line Items
customerInformation.email string

Customer's email address. The invoice is sent to this address.

customerInformation.name string

Customer's full name as it appears on the invoice.

invoiceInformation.deliveryMode string

Set to email.

invoiceInformation.dueDate string

The date payment is due. Format: YYYY-MM-DD.

invoiceInformation.sendImmediately boolean

Set to true.

orderInformation.amountDetails.currency string

ISO 4217 three-letter currency code for the invoice.

orderInformation.amountDetails.totalAmount string

The total charge amount for the invoice, as a decimal string.

orderInformation.lineItems[].productName string

Display name of the line item as it appears on the invoice.

orderInformation.lineItems[].productSku string

Stock-keeping unit identifier for this line item.

orderInformation.lineItems[].quantity integer

Number of units for this line item.

orderInformation.lineItems[].totalAmount number

Total amount for this line item.

orderInformation.lineItems[].unitPrice number

Price per unit for this line item.

Optional Fields

You can include these optional fields when sending create invoice requests:

Optional Fields
clientReferenceInformation.partner.developerId string

Set to your developer ID.

clientReferenceInformation.partner.solutionId string

Set to your partner solution ID (PSID).

customerInformation.company.name string

Customer's company name as it appears on the invoice.

customerInformation.email string

Customer's email address.

customerInformation.merchantCustomerId string

Your identifier for this customer in your system.

customerInformation.name string

Customer's full name as it appears on the invoice.

invoiceInformation.allowPartialPayments boolean

Set to one of these possible values: false the invoice must be paid in a single payment, or true the invoice is payable in installments.

invoiceInformation.deliveryMode string

Set to email to email the invoice to the customer, or none to create a payable link without sending an email.

invoiceInformation.description string

This field is optional when the line item fields are present in the request message.

invoiceInformation.expirationDate string

Set to the expiration date. Format: YYYY-MM-DD. The invoice expires on this date at 00:00 GMT.

invoiceInformation.invoiceNumber string

Set to a unique number to create an invoice number. If you do not include this field and a unique value, the invoicing API automatically generates an invoice number for the new invoice. You cannot update this invoice number after sending the API request.

merchantDefinedFieldValues.definition id[].value string

Value for a merchant-defined custom field.

orderInformation.amountDetails.freight.amount number

Freight or shipping amount added to the invoice total.

orderInformation.amountDetails.freight.taxable boolean

Set to true if freight is subject to tax.

orderInformation.amountDetails.freight.taxRate number

Tax rate applied to the freight amount.

orderInformation.amountDetails.minimumPartialAmount number

The minimum amount allowed for a single installment payment. Only applies when allowPartialPayments is true.

orderInformation.amountDetails.subAmount number

The subtotal before discounts or tax adjustments.

Last published: October 28, 2026

Not available for your audience

This page isn't available for your current audience selection.