Happy Business Starts Here

Highlighted
Master

Example of Request to Update RatePlanChargeTier using amend call

I hope that will help someone:

 

I looked for Knowledge Center and Community.

However, an example of Update RatePlanChargeTier using /v1/action/amend could not be found.

I tried it and I realized it in the following way.

 

This is the assumption:
TierBeforeAfter.png

 

The Request:

[POST] https://rest.apisandbox.zuora.com/v1/action/amend

 

{
  "requests": [
    {
      "AmendOptions": {
        "GenerateInvoice": true,
        "InvoiceProcessingOptions": {
          "InvoiceTargetDate": "2018-02-01"
        },
        "ProcessPayments": false
      },
      "Amendments": [
        {
          "ContractEffectiveDate": "2018-02-01",
          "ServiceActivationDate": "2018-02-01",
          "CustomerAcceptanceDate": "2018-02-01",
          "Name": "Tier Update",
          "RatePlanData": {
            "RatePlan": {
              "AmendmentSubscriptionRatePlanId": "2c92c0f96078cfc60160bb32a70737e9"
            },
            "RatePlanChargeData": [
              {
                "RatePlanCharge": {
                  "ProductRatePlanChargeId": "2c92c0f86078c5990160bb2c1aab2742",
                  "Quantity": 50.0
                },
                "RatePlanChargeTier": [
                  {
                    "Tier": 1,
                    "Price": 500.0
                  },
                  {
                    "Tier": 2,
                    "Price": 400.0
                  },
                  {
                    "Tier": 3,
                    "Price": 250.0
                  }
                ]
              }
            ]
          },
          "SubscriptionId": "2c92c0f96078cfc60160bb32a5cb37e2",
          "Type": "UpdateProduct"
        }
      ]
    }
  ]
}

 

Tips:

  • To designate Tier, use "Tier" instead of Id.
  • If ChargeType = Volume or Tier, specifying RatePlanCharge.Quantity is needed (even if the quantity is not changed).
1 REPLY 1
Community Manager

Re: Example of Request to Update RatePlanChargeTier using amend call

This is great!  Thanks for sharing it with us @yamasaki1ma and happy new year!


Lana Lee | Senior Community Manager and Strategist
"A little consideration, a little thought for others, makes all the difference." —A. A. Milne