Skip to main content
GET
/
planDetails
/
{plan_id}
/
charges
List plan charges
curl --request GET \
  --url https://api.metronome.com/v1/planDetails/{plan_id}/charges \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "charge_type": "usage",
      "product_id": "<string>",
      "product_name": "<string>",
      "credit_type": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "prices": [
        {
          "value": 123,
          "tier": 123,
          "quantity": 123,
          "collection_schedule": "<string>",
          "collection_interval": 123
        }
      ],
      "custom_fields": {},
      "quantity": 123,
      "start_period": 123,
      "tier_reset_frequency": 123,
      "unit_conversion": {
        "division_factor": 123,
        "rounding_behavior": "floor"
      }
    }
  ],
  "next_page": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

plan_id
string<uuid>
required

Query Parameters

limit
integer

Max number of results that should be returned

Required range: 1 <= x <= 100
next_page
string

Cursor that indicates where the next page of results should start.

Response

200 - application/json

Success

data
object[]
required
next_page
string | null
required