GET
/
report
/
products-usage
curl --request GET \
  --url https://connect.withvayu.com/report/products-usage \
  --header 'Authorization: Bearer <token>'
{
  "contractStatus": "Active",
  "customerName": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "contractName": "<string>",
  "contractStartDate": "2023-11-07T05:31:56Z",
  "contractEndDate": "2023-11-07T05:31:56Z",
  "daysToContractEnd": 123,
  "productVariantName": "<string>",
  "commitmentConsumptionPercentage": 123,
  "totalCommitmentCurrencyAmount": 123,
  "totalCommitmentUnitsAmount": 123,
  "commercialTermsAmount": 123,
  "erpId": "<string>",
  "currency": "USD",
  "usageConsumptionCurrencyAmount": 123,
  "usageConsumptionUnitsAmount": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

reportId
string
limit
number
default:10
Required range: x <= 1000
cursor
string

Response

200
application/json
response contains the products usage report
contractStatus
enum<string>
required
Available options:
Active,
Inactive,
Terminated,
PendingTermination,
Error
customerName
string
required
startDate
string
required
endDate
string
required
contractStartDate
string
required
productVariantName
string
required
currency
enum<string>
required
Available options:
USD,
EUR,
GBP,
ILS
contractName
string
contractEndDate
string
daysToContractEnd
number
commitmentConsumptionPercentage
number
totalCommitmentCurrencyAmount
number
totalCommitmentUnitsAmount
number
commercialTermsAmount
number
erpId
string
usageConsumptionCurrencyAmount
number
usageConsumptionUnitsAmount
number