ALalternativepayments
Invoices

Create an invoice

Changed on

Create a new invoice with line items

post/invoices

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/invoices
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: invoices:write

Request body

currency'USD'

Invoices are always issued in USD; any other currency is rejected.

customer_idstring
due_datestring

Due date in YYYY-MM-DD format. If omitted, defaults to the current date from invoice creation.

exclude_from_autopayboolean

When true, this invoice is excluded from Autopay at creation time. Use this when your integration pays the invoice synchronously via API and you want to guarantee Autopay never charges the same invoice. Defaults to false.

Example request

{
  "currency": "USD",
  "due_date": "2025-01-01"
}

Response

Created

created_atstring
currencystring
customer_idstring
due_datestring
idstring
invoice_numberstring
last_notification_atstring
memostring
outstanding_amountnumber

Amount still owed: total less payments and credits, including payments synchronized from the accounting system

statusstring
sub_totalnumber

Sum of the line items, before tax

taxnumber

Sales tax

totalnumber

Changes