Retrieve usage records

Retrieves a list of usage records.

SecuritySecretApiKey or JWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of usage records retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
subscriptionId
required
string <= 50 characters

ID of the subscription for which a usage is reported.

planId
required
string <= 50 characters

ID of the plan for which a usage is reported.

quantity
required
number <float> > 0

Number of used product units of a plan. Products are the goods and services that your business sells. Plans describe how the customer must pay for products.

id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters

ID of the invoice to which usage is applied. This value is populated when the invoice is issued.

invoiceItemId
string or null <= 50 characters

ID of the invoice item to which usage is applied. This value is populated when the invoice is issued.

usageTime
string <date-time>

Date and time, in ISO 8601 format, at which a usage occurred. If this value is not provided or is empty, the date and time of the request is used.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of Self (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/usages
Request samples
Response samples
application/json
[
  • {
    }
]