Usage Lines

Save Usage Lines

A subscriptionId OR an externalSubscriptionId is required

post/lines

Request

  • Base URL
    https://api.pax8.com/v2/usage
  • URL
    https://api.pax8.com/v2/usage/lines
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.pax8.com/v1/token

Query parameters

subscriptionIdstring uuid
externalSubscriptionIdstring
billingPeriodstring required

Billing period with format yyyy-MM

overwriteSameDayUsageboolean

When set to false, usage lines for the same summary key will be appended instead of replacing existing same-day lines

isSimulationboolean

When set to true, usage lines will be saved as a simulation and will not affect billing or reporting

Request body

summaryKeystring required
summaryDisplayNamestring required
quantitynumber required
productIdstring uuid required
unitOfMeasurementstring required

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.