Usage Lines
Get All Usage Lines
A subscriptionId OR an externalSubscriptionId is required.
There are two ways to retrieve usage lines:
- With summaryKey — returns all usage lines for that summary key, without pagination.
- Without summaryKey — returns paginated results of all usage lines for the subscription. Use the page and size parameters to control pagination.
get/lines
Request
- Base URLhttps://api.pax8.com/v2/usage
- URLhttps://api.pax8.com/v2/usage/lines
- AuthOAuth 2Client credentialsToken URL: https://api.pax8.com/v1/token
Query parameters
subscriptionIdstring uuid
externalSubscriptionIdstring
billingPeriodstring required
Billing period with format yyyy-MM
summaryKeystring
Optional. Filter by specific summary key. When provided the response isn't paginated.
isSimulationboolean
When set to true, returns simulated usage lines instead of production usage lines
pageinteger
Page number (0-based). Only used when summaryKey is not provided.
sizeinteger
Page size (max 100). Only used when summaryKey is not provided.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.