latestSwagger 2.02026-08-109450223.9 KB

94acb422c07d

Invoices

List Account Invoices

Shows Invoices associated with your account.

Note: This endpoint will also return a pagination key on the root level.
Please refer to the pagination section within our docs for more information.

get/v1/invoices

Query parameters

limitinteger

Max number of resources returned in a paged collection. Defaults to 10, with a minimum of 1 and maximum 500.

page_tokenstring

Token used to request the next page in paginated results. Defaults to 'null'

sort_field'id' | 'created_at' | 'updated_at' | 'status'

Field to sort by. Defaults to 'id'.

sort_direction'asc' | 'desc'

Sort direction. Defaults to 'desc'.

Filter by status. One of open, paid, failed, partial_refund, full_refund, draft, voided, processing

has_usageboolean

When true, returns only invoices with usage (subscription-cycle invoices). When false, returns only invoices without usage (manually-created invoices).

Response

List Account Invoices

Example response

{
  "invoices": [
    {
      "id": 1,
      "amount": 303,
      "created_at": "2022-03-01T20:56:15Z",
      "currency_type": "usd",
      "plan": "Huntress Partner 100 Agents",
      "quantity": 101,
      "receipt": "https://pay.stripe/com/invoice/invst_uuid",
      "status": "paid",
      "has_usage": true,
      "updated_at": "2022-03-01T20:56:15Z"
    }
  ]
}