List

API Reference

V1

Plans

List plans

v1.plans.list(PlanListParams**kwargs) -> SyncCursorPage[idstrdescriptionstrnamestrcustom_fieldsDict[str, str]PlanListResponse]

get/v1/plans

List all available plans.

Parameters

limitint

optional

Max number of results that should be returned

minimum1

maximum100

next_pagestr

optional

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

Returns

PlanListResponseclass

Hide ParametersShow Parameters

idstr

formatuuid

descriptionstr

namestr

custom_fieldsDict[str, str]

optional

Optional[Dict[str, str]]

HTTPTypeScriptPythonGoRubyTerraform

from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
page = client.v1.plans.list()
page = page.data[0]
print(page.id)

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "description": "description",
      "name": "name",
      "custom_fields": {
        "foo": "string"
      }
    }
  ],
  "next_page": "next_page"
}