SMsmokeball
Subscriptions

Get subscription invoices

Changed on

Retrieves invoices for the account.

Invoices are returned sorted by creation date with the most recent invoices appearing first.

get/subscriptions/invoices

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/subscriptions/invoices
  • Auth
    API key in header x-api-key and API key in header Authorization

Query parameters

Offsetinteger
Limitinteger
Fromstring date-time

Search for invoices created on or after From (inclusive lower bound).

Tostring date-time

Search for invoices created on or before To (inclusive upper bound).

SubscriptionIdstring

Search for invoices belonging to the specified internal subscription id.

Response

When request is successful. Returns a paged collection of 'SubscriptionInvoice' objects.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger

Example response

{
  "value": [
    {
      "status": "Paid",
      "total": 1899,
      "subTotal": 1000,
      "tax": 100,
      "preTaxCredit": 200,
      "lineItems": [
        {
          "amount": 109,
          "preTaxCredit": 200,
          "quantity": 3,
          "periodStart": "2026-10-01T00:00:00Z",
          "periodEnd": "2026-11-01T00:00:00Z"
        }
      ],
      "createdDate": "2022-04-23T14:00:00Z"
    }
  ]
}

Changes

  • 2fe552c5d11dRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status