GET
/
billableMetrics
List billable metrics
curl --request GET \
  --url https://api.paygentic.io/v0/billableMetrics \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "billableMetric",
      "name": "<string>",
      "description": "<string>",
      "merchantId": "<string>",
      "unit": "<string>",
      "aggregation": "SUM",
      "productId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

merchantId
string
required

Filter billable metrics by merchant organization ID.

productId
string

Filter billable metrics by product ID.

limit
integer
default:10

Number of billable metrics to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of billable metrics to skip.

Required range: x >= 0

Response

List of billable metrics

object
enum<string>
required
Available options:
list
data
object[]
required
pagination
object
required