List Charges

API Reference

V1

Plans

List plan charges

v1.plans.list_charges(**kwargs) -> CursorPage<idStringcharge_typeunioncredit_typeCreditTypeDatacustom_fieldshashnameStringpricesarrayproduct_idStringproduct_nameStringquantityFloatstart_periodFloattier_reset_frequencyFloatunit_conversionobjectPlanListChargesResponse>

get/v1/planDetails/{plan_id}/charges

Fetches a list of charges of a specific plan.

Parameters

plan_idString

formatuuid

limitInteger

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

PlanListChargesResponseclass

Hide ParametersShow Parameters

idString

formatuuid

charge_typeunion

:usage | :fixed | :composite | 2 more

Hide ParametersShow Parameters

:usage

:fixed

:composite

:minimum

:seat

credit_typeidStringnameStringCreditTypeData

custom_fieldshash

Hash[Symbol, String]

nameString

pricesarray

Array[{ tier, value, collection_interval, 2 more}]

Hide ParametersShow Parameters

tierFloat

Used in pricing tiers. Indicates at what metric value the price applies.

valueFloat

collection_intervalFloat

optional

collection_scheduleString

optional

quantityFloat

optional

product_idString

product_nameString

quantityFloat

optional

start_periodFloat

optional

Used in price ramps. Indicates how many billing periods pass before the charge applies.

tier_reset_frequencyFloat

optional

Used in pricing tiers. Indicates how often the tier resets. Default is 1 - the tier count resets every billing period.

unit_conversionobject

optional

{ division_factor, rounding_behavior}

Specifies how quantities for usage based charges will be converted.

Hide ParametersShow Parameters

division_factorFloat

The conversion factor

rounding_behaviorunion

optional

:floor | :ceiling

Whether usage should be rounded down or up to the nearest whole number. If null, quantity will be rounded to 20 decimal places.

Hide ParametersShow Parameters

:floor

:ceiling

HTTPTypeScriptPythonGoRubyTerraform

require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

page = metronome.v1.plans.list_charges(plan_id: "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc")

puts(page)

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"
}