v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
License

Get usage for all licenses of a type on a subscription

Returns usage and remaining credits for all licenses of a given type on a subscription.

Date range defaults to the current billing period if not specified.

get/licenses/usage

Query parameters

start_datestring date nullable

Start date for the usage period (YYYY-MM-DD). Defaults to start of current billing period.

end_datestring date nullable

End date for the usage period (YYYY-MM-DD). Defaults to end of current billing period.

group_bystring nullable

How to group the results. Valid values: 'license', 'day'. Can be combined (e.g., 'license,day').

cursorstring nullable

Pagination cursor from a previous request.

limitinteger

Maximum number of rows in the response data (default 20, max 100).

subscription_idstring required

The subscription ID to get license usage for.

license_type_idstring required

The license type ID to filter licenses by.

Response

OK