List

API Reference

V1

Pricing Units

List pricing units

client.v1.pricingUnits.list(PricingUnitListParamsquery?, RequestOptionsoptions?): CursorPage<idstringis_currencybooleannamestringPricingUnitListResponse>

get/v1/credit-types/list

List all pricing units (known in the API by the legacy term "credit types").

Parameters

querylimitnumbernext_pagestringPricingUnitListParams

Hide ParametersShow 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

PricingUnitListResponse

Hide ParametersShow Parameters

idstring

optional

formatuuid

is_currencyboolean

optional

namestring

optional

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

// Automatically fetches more pages as needed.
for await (const pricingUnitListResponse of client.v1.pricingUnits.list()) {
  console.log(pricingUnitListResponse.id);
}

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "is_currency": true,
      "name": "name"
    }
  ],
  "next_page": "next_page"
}