Skip to main content
GET
/
customers
/
{customer_id}
/
plans
/
{customer_plan_id}
/
priceAdjustments
Get the plan adjustments for a customer
curl --request GET \
  --url https://api.metronome.com/v1/customers/{customer_id}/plans/{customer_plan_id}/priceAdjustments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "charge_id": "8b24d3dc-6db5-432d-9416-8439b3fbf242",
      "charge_type": "usage",
      "start_period": 0,
      "prices": [
        {
          "adjustment_type": "fixed",
          "value": -0.05
        },
        {
          "adjustment_type": "quantity",
          "value": 2
        },
        {
          "adjustment_type": "override",
          "tier": 2,
          "value": 4
        }
      ]
    },
    {
      "charge_id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
      "charge_type": "fixed",
      "start_period": 1,
      "prices": [
        {
          "adjustment_type": "percentage",
          "value": -5
        }
      ]
    }
  ],
  "next_page": "31646362333134302d363735362d346661372d396436362d383"
}

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
customer_plan_id
string<uuid>
required

the ID of a customer-plan relationship

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
I