List

API Reference

V1

Customers

Plans

List customer plans

get/v1/customers/{customer_id}/plans

List the given customer's plans in reverse-chronological order.

Path Parameters

customer_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/customers/$CUSTOMER_ID/plans \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN"

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "custom_fields": {
        "foo": "string"
      },
      "plan_description": "plan_description",
      "plan_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "plan_name": "plan_name",
      "starting_on": "2019-12-27T18:11:19.117Z",
      "ending_before": "2019-12-27T18:11:19.117Z",
      "net_payment_terms_days": 0,
      "trial_info": {
        "ending_before": "2019-12-27T18:11:19.117Z",
        "spending_caps": [
          {
            "amount": 123.45,
            "amount_remaining": 123,
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            }
          }
        ]
      }
    }
  ],
  "next_page": "next_page"
}