Invoices

List invoices

get

Get a paginated list of invoices with optional filtering

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

Query parameters

limitintegerOptional

Number of items to return

Default: 100

afterstringOptional

Specifies the cursor after which to start returning results. For the first page, this should be left empty. For subsequent pages, use the value of the end_cursor field from the previous response.

beforestringOptional

Specifies the cursor before which to return results. Use this to paginate backwards. For example, to load the previous page, provide the value of the start_cursor field from the last response.

created_at_startstringOptional

Filter by creation date start (RFC3339 format)

created_at_endstringOptional

Filter by creation date end (RFC3339 format)

due_date_startstringOptional

Filter by due date start (RFC3339 format)

due_date_endstringOptional

Filter by due date end (RFC3339 format)

customer_idstringOptional

Filter by customer ID

invoice_numberstringOptional

Filter by invoice number

statusstring · enumOptional

Filter by invoice status

Possible values:

Responses

200

OK

application/json

end_cursorstringOptionalExample: gaFpxBACEaXBVABEYbHG+X9LyLnH

has_next_pagebooleanOptionalExample: true

has_previous_pagebooleanOptional

start_cursorstringOptionalExample: gaFpxBACEaXBVABEYbHG+X9LyLnH

400

Bad Request

application/json

get

/invoices

HTTPcURLJavaScriptPython

GET /invoices HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "created_at": "text",
      "currency": "text",
      "customer_id": "text",
      "due_date": "text",
      "id": "text",
      "invoice_number": "text",
      "last_notification_at": "text",
      "line_items": [
        {
          "amount": 1,
          "description": "text",
          "quantity": 1
        }
      ],
      "memo": "text",
      "status": "text",
      "sub_total": 1,
      "total": 1
    }
  ],
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "has_previous_page": false,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}

Create an invoice

post

Create a new invoice with line items

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

customer_idstringOptional

due_datestringOptional

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

Example: 2025-01-01

exclude_from_autopaybooleanOptional

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.

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/invoices

HTTPcURLJavaScriptPython

POST /invoices HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "customer_id": "text",
  "due_date": "2025-01-01",
  "exclude_from_autopay": false,
  "line_items": [
    {
      "amount": 1,
      "description": "text",
      "quantity": 1
    }
  ]
}

{
  "created_at": "text",
  "currency": "text",
  "customer_id": "text",
  "due_date": "text",
  "id": "text",
  "invoice_number": "text",
  "last_notification_at": "text",
  "line_items": [
    {
      "amount": 1,
      "description": "text",
      "quantity": 1
    }
  ],
  "memo": "text",
  "status": "text",
  "sub_total": 1,
  "total": 1
}

Get an invoice

get

Get invoice details by ID

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idstringRequired

Invoice ID

Responses

200

OK

application/json

created_atstringOptional

currencystringOptional

customer_idstringOptional

due_datestringOptional

idstringOptional

invoice_numberstringOptional

last_notification_atstringOptional

memostringOptional

statusstringOptional

sub_totalnumberOptional

totalnumberOptional

404

Not Found

application/json

get

/invoices/{id}

HTTPcURLJavaScriptPython

GET /invoices/{id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "created_at": "text",
  "currency": "text",
  "customer_id": "text",
  "due_date": "text",
  "id": "text",
  "invoice_number": "text",
  "last_notification_at": "text",
  "line_items": [
    {
      "amount": 1,
      "description": "text",
      "quantity": 1
    }
  ],
  "memo": "text",
  "status": "text",
  "sub_total": 1,
  "total": 1
}

Archive an invoice

delete

Archive an invoice

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idstringRequired

Invoice ID

Responses

200

OK

application/json

created_atstringOptional

currencystringOptional

customer_idstringOptional

due_datestringOptional

idstringOptional

invoice_numberstringOptional

last_notification_atstringOptional

memostringOptional

statusstringOptional

sub_totalnumberOptional

totalnumberOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/invoices/{id}

HTTPcURLJavaScriptPython

DELETE /invoices/{id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "created_at": "text",
  "currency": "text",
  "customer_id": "text",
  "due_date": "text",
  "id": "text",
  "invoice_number": "text",
  "last_notification_at": "text",
  "line_items": [
    {
      "amount": 1,
      "description": "text",
      "quantity": 1
    }
  ],
  "memo": "text",
  "status": "text",
  "sub_total": 1,
  "total": 1
}

Get hosted payment link for invoice

get

Get a payment link for the specified invoice

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idstringRequired

Invoice ID

Responses

200

OK

application/json

urlstringOptional

400

Bad Request

application/json

404

Not Found

application/json

get

/invoices/{id}/payment-link

HTTPcURLJavaScriptPython

GET /invoices/{id}/payment-link HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "url": "text"
}

Get invoice PDF link

get

Get a signed PDF URL for the specified invoice

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idstringRequired

Invoice ID

Responses

200

OK

application/json

urlstringOptional

400

Bad Request

application/json

404

Not Found

application/json

get

/invoices/{id}/pdf-link

HTTPcURLJavaScriptPython

GET /invoices/{id}/pdf-link HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "url": "text"
}

Restore an invoice

post

Restore an invoice

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idstringRequired

Invoice ID

Responses

200

OK

application/json

created_atstringOptional

currencystringOptional

customer_idstringOptional

due_datestringOptional

idstringOptional

invoice_numberstringOptional

last_notification_atstringOptional

memostringOptional

statusstringOptional

sub_totalnumberOptional

totalnumberOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/invoices/{id}/restore

HTTPcURLJavaScriptPython

POST /invoices/{id}/restore HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "created_at": "text",
  "currency": "text",
  "customer_id": "text",
  "due_date": "text",
  "id": "text",
  "invoice_number": "text",
  "last_notification_at": "text",
  "line_items": [
    {
      "amount": 1,
      "description": "text",
      "quantity": 1
    }
  ],
  "memo": "text",
  "status": "text",
  "sub_total": 1,
  "total": 1
}