API Reference
- Customers
- Products
- Plans
- Contracts
- Invoices
- Measurements
- Auth
- Events
- Reports
- Integrations
- Credits
- Webhooks
List Products
Get a list of Products.
curl --request GET \
--url https://connect.withvayu.com/products \
--header 'Authorization: Bearer <token>'{
"products": [
{
"name": "<string>",
"eventName": "<string>",
"aggregationMethod": {
"operator": "Count",
"field": "<string>",
"instanceKey": "<string>"
},
"filter": {
"conditions": [
{
"criterions": [
{
"field": "<string>",
"operator": "Equals",
"value": "<string>"
}
]
}
]
},
"pricing": {
"pricingModel": "PerUnit",
"priceConfiguration": {
"price": 1,
"chunkSize": 1
}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"hasMore": true,
"nextCursor": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
The name of the meter
1The name of the event that the meter is tracking.
1The aggregation method defines how the events should be summed to represent a usage value.
The aggregation method defines how the events should be summed to represent a usage value.
Count, Sum, Distinct, Max, Min, Average, First, Last The field inside the "data" property to apply the aggregation method to.
The fields that is used to group different events together when measuring the usage.
The filter to apply to the events to be included in the meter. The filter object contains an array of Conditions, each condition represents a logical OR statement. Each condition contains an array of Criteria (criterions), each criterion represents a logical AND statement.
1Equals, DoesntEqual, Has, In, Contains, DoesntContain, LargerThan, LowerThan, LowerEqualTo, LargerEqualTo, Exists, DoesntExists 1The pricing data of the meter. The pricing data contains the pricing model and the pricing details.
curl --request GET \
--url https://connect.withvayu.com/products \
--header 'Authorization: Bearer <token>'{
"products": [
{
"name": "<string>",
"eventName": "<string>",
"aggregationMethod": {
"operator": "Count",
"field": "<string>",
"instanceKey": "<string>"
},
"filter": {
"conditions": [
{
"criterions": [
{
"field": "<string>",
"operator": "Equals",
"value": "<string>"
}
]
}
]
},
"pricing": {
"pricingModel": "PerUnit",
"priceConfiguration": {
"price": 1,
"chunkSize": 1
}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"hasMore": true,
"nextCursor": "<string>"
}