List

API Reference

V1

Plans

List plans

v1.plans.list(**kwargs) -> CursorPage<idStringdescriptionStringnameStringcustom_fieldshashPlanListResponse>

get/v1/plans

List all available plans.

Parameters

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

PlanListResponseclass

Hide ParametersShow Parameters

idString

formatuuid

descriptionString

nameString

custom_fieldshash

optional

Hash[Symbol, String]

HTTPTypeScriptPythonGoRubyTerraform

require "metronome_sdk"

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

page = metronome.v1.plans.list

puts(page)

200 Example

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