List Price Adjustments

Get the plan adjustments for a customer

client.V1.Customers.Plans.ListPriceAdjustments(ctx, params) (*CursorPage[], error)

get/v1/customers/{customer_id}/plans/{customer_plan_id}/priceAdjustments

Lists a customer plans adjustments. See the price adjustments documentation for details.

Parameters

params

Hide ParametersShow Parameters

CustomerIDfield

param.Field[string]

Path param:

formatuuid

CustomerPlanIDfield

param.Field[string]

Path param: the ID of a customer-plan relationship

formatuuid

Limitfield

optional

param.Field[int64]

Query param: Max number of results that should be returned

minimum1

maximum100

NextPagefield

optional

param.Field[string]

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

Returns

V1CustomerPlanListPriceAdjustmentsResponsestruct

Hide ParametersShow Parameters

ChargeIDstring

formatuuid

ChargeType

Hide ParametersShow Parameters

V1CustomerPlanListPriceAdjustmentsResponseChargeTypeUsageconst

"usage"

V1CustomerPlanListPriceAdjustmentsResponseChargeTypeFixedconst

"fixed"

V1CustomerPlanListPriceAdjustmentsResponseChargeTypeCompositeconst

"composite"

V1CustomerPlanListPriceAdjustmentsResponseChargeTypeMinimumconst

"minimum"

V1CustomerPlanListPriceAdjustmentsResponseChargeTypeSeatconst

"seat"

Pricesarray

[]V1CustomerPlanListPriceAdjustmentsResponsePrice

Hide ParametersShow Parameters

AdjustmentType

Determines how the value will be applied.

Hide ParametersShow Parameters

V1CustomerPlanListPriceAdjustmentsResponsePricesAdjustmentTypeFixedconst

"fixed"

V1CustomerPlanListPriceAdjustmentsResponsePricesAdjustmentTypeQuantityconst

"quantity"

V1CustomerPlanListPriceAdjustmentsResponsePricesAdjustmentTypePercentageconst

"percentage"

V1CustomerPlanListPriceAdjustmentsResponsePricesAdjustmentTypeOverrideconst

"override"

Tierfloat64

optional

Used in pricing tiers. Indicates at what metric value the price applies.

Valuefloat64

optional

StartPeriodfloat64

Quantityfloat64

optional

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  page, err := client.V1.Customers.Plans.ListPriceAdjustments(context.TODO(), metronome.V1CustomerPlanListPriceAdjustmentsParams{
    CustomerID: metronome.F("d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"),
    CustomerPlanID: metronome.F("7aa11640-0703-4600-8eb9-293f535a6b74"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

200 Example

{
  "data": [
    {
      "charge_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "charge_type": "usage",
      "prices": [
        {
          "adjustment_type": "fixed",
          "tier": 0,
          "value": 0
        }
      ],
      "start_period": 0,
      "quantity": 0
    }
  ],
  "next_page": "next_page"
}