List Charges

API Reference

V1

Plans

List plan charges

get/v1/planDetails/{plan_id}/charges

Fetches a list of charges of a specific plan.

Path Parameters

plan_idstring

formatuuid

Query Parameters

limitnumber

optional

Max number of results that should be returned

minimum1

maximum100

next_pagestring

optional

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

Returns

dataarray of object

next_pagestring

HTTPTypeScriptPythonGoRubyTerraform

curl https://api.metronome.com/v1/planDetails/$PLAN_ID/charges \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN"

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "charge_type": "usage",
      "credit_type": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "name": "name"
      },
      "custom_fields": {
        "foo": "string"
      },
      "name": "name",
      "prices": [
        {
          "tier": 0,
          "value": 0,
          "collection_interval": 0,
          "collection_schedule": "collection_schedule",
          "quantity": 0
        }
      ],
      "product_id": "product_id",
      "product_name": "product_name",
      "quantity": 0,
      "start_period": 0,
      "tier_reset_frequency": 0,
      "unit_conversion": {
        "division_factor": 0,
        "rounding_behavior": "floor"
      }
    }
  ],
  "next_page": "next_page"
}