v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Subscriptions

Get subscription invoices

Retrieves invoices for the account.

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

get/subscriptions/invoices

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