Skip to main content
GET
/
customers
/
{customer_id}
/
plans
List customer plans
curl --request GET \
  --url https://api.metronome.com/v1/customers/{customer_id}/plans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "plan_name": "<string>",
      "plan_description": "<string>",
      "starting_on": "2023-11-07T05:31:56Z",
      "custom_fields": {},
      "ending_before": "2023-11-07T05:31:56Z",
      "net_payment_terms_days": 123,
      "trial_info": {
        "ending_before": "2023-11-07T05:31:56Z",
        "spending_caps": [
          {
            "credit_type": {
              "name": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "amount": 123.45,
            "amount_remaining": 123
          }
        ]
      }
    }
  ],
  "next_page": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customer_id
string<uuid>
required

Query Parameters

​
limit
integer

Max number of results that should be returned

Required range: 1 <= x <= 100
​
next_page
string

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

Response

200 - application/json

Success

​
data
object[]
required
​
next_page
string | null
required