v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Subscriptions

Get invoices for a subscription (deprecated)

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

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
        }
      ],
      "createdDate": "2022-04-23T14:00:00Z"
    }
  ]
}