GET
/
invoices
List Invoices
curl --request GET \
  --url https://api.alguna.io/invoices \
  --header 'Authorization: Bearer <token>'
{
    "items": [
        {
            "id": "ZVzWRFnt",
            "accountId": "aBsZxlLh",
            "currency": "USD",
            "description": "Platform subscription",
            "billingPeriodStart": "2024-02-01T00:00:00Z",
            "billingPeriodEnd": "2024-02-29T23:59:59Z",
            "status": "upcoming",
            "total": "200.00",
            "billingPeriod": "Feb 01, 24 - Feb 29, 24",
            "createdAt": "2024-01-24T16:36:52.78883Z",
            "updatedAt": "2024-01-26T19:30:37.734294Z"
        },
        {
            "id": "jqsKFrxO",
            "accountId": "JXvYcskd",
            "currency": "USD",
            "description": "Monthly seats",
            "billingPeriodStart": "2024-02-01T00:00:00Z",
            "billingPeriodEnd": "2024-02-29T23:59:59Z",
            "status": "upcoming",
            "total": "500.00",
            "billingPeriod": "Feb 01, 24 - Feb 29, 24",
            "createdAt": "2024-01-24T16:25:48.027798Z",
            "updatedAt": "2024-01-26T19:30:38.083477Z"
        }]
}

​
Response

{
    "items": [
        {
            "id": "ZVzWRFnt",
            "accountId": "aBsZxlLh",
            "currency": "USD",
            "description": "Platform subscription",
            "billingPeriodStart": "2024-02-01T00:00:00Z",
            "billingPeriodEnd": "2024-02-29T23:59:59Z",
            "status": "upcoming",
            "total": "200.00",
            "billingPeriod": "Feb 01, 24 - Feb 29, 24",
            "createdAt": "2024-01-24T16:36:52.78883Z",
            "updatedAt": "2024-01-26T19:30:37.734294Z"
        },
        {
            "id": "jqsKFrxO",
            "accountId": "JXvYcskd",
            "currency": "USD",
            "description": "Monthly seats",
            "billingPeriodStart": "2024-02-01T00:00:00Z",
            "billingPeriodEnd": "2024-02-29T23:59:59Z",
            "status": "upcoming",
            "total": "500.00",
            "billingPeriod": "Feb 01, 24 - Feb 29, 24",
            "createdAt": "2024-01-24T16:25:48.027798Z",
            "updatedAt": "2024-01-26T19:30:38.083477Z"
        }]
}
​
id
string
The Alguna ID of the invoice.
​
accountId
string
The Alguna ID of the account associated with the invoice.
​
currency
string
The ISO 4217 currency in which the invoice is billed.
​
description
string
The description or memo for the invoice, such as “Platform subscription”.
​
billingPeriodStart
string
The start date of the billing period for the invoice. (RFC 3339 timestamp)
​
billingPeriodEnd
string
The end date of the billing period for the invoice. (RFC 3339 timestamp)
​
status
string
The status of the invoice, e.g., “upcoming”. For more info on invoice statuses see the invoice status guide.
​
total
string
The total amount of the invoice as a decimal string e.g., “200.00”.
​
billingPeriod
string
The formatted billing period for the invoice.
​
createdAt
datetime
The date and time at which the invoice was created.
​
updatedAt
datetime
The date and time at which the invoice was last updated.