APappdirect
Subscriptions

List all invoices for a subscription

Changed on

List all of the invoices for the given subscription

get/billing/v1/subscriptions/{subscriptionId}/invoices

Request

Path parameters

subscriptionIdstring required

Subscription ID

Query parameters

countinteger

Number of results to fetch. Used for paging.

excludeFreeboolean

Exclude invoices with no charges (free)

fromDatenumber

From date

sortField'DATE' | 'INVOICE_ID' | 'TOTAL'

Sort field

sortOrder'ASC' | 'DESC'

Sort order

startinteger

First result index. Used for paging.

status'CARRIED' | 'PAID' | 'UNPAID' | 'VOIDED'

Invoice status

toDatenumber

To date

Response

OK

creationDatenumber nullable

Creation date for the invoice.

orderIdsstring[]

Array of Order IDs

currency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

Supported currencies for the system

dueDatenumber nullable

Due date for the invoice.

invoiceIdnumber nullable

Invoice ID.

referenceNumberstring nullable

Reference number.

status'PAID' | 'UNPAID' | 'CARRIED' | 'VOIDED'
totalnumber nullable

Invoice total.

Example response

[
  {
    "company": {
      "href": "...",
      "id": "..."
    },
    "creationDate": 12345,
    "currency": "DKK",
    "dueDate": 12345,
    "invoiceId": 12345,
    "links": [
      {
        "href": "...",
        "rel": "..."
      },
      {
        "href": "...",
        "rel": "..."
      }
    ],
    "referenceNumber": "...",
    "status": "PAID",
    "total": 12345,
    "user": {
      "href": "...",
      "id": "..."
    }
  }
]

Changes