Subscriptions

Get invoices for a subscription (deprecated)

Changed on

DEPRECATED - Use GET /subscriptions/invoices instead.

Retrieves invoices for the specified subscription.

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

get/subscriptions/{subscriptionId}/invoices

Request

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

Path parameters

subscriptionIdstring required

The unique identifier of the subscription

Query parameters

limitinteger

The maximum number of invoices to return.

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

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

    • info

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

    • info

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