Sign in
Commerce

Update a product rate plan

Updates an existing Product Rate Plan (PRP) in the Product Catalog. Use this API to update core plan fields such as name, description, grade, and effective dates.

put/commerce/plans

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request body

idstring required

Unique identifier of the Product Rate Plan to update.

namestring

Rate plan name.

descriptionstring

Rate plan description.

gradeinteger

Plan grade or display rank used for ordering in catalogs or UIs.

startDatestring date

Rate plan effective start date (UTC, YYYY-MM-DD).

endDatestring date

Rate plan effective end date (UTC, YYYY-MM-DD).

Example request

{
  "id": "5758b1d5a589840e0e6855e1c2ce014d",
  "name": "Bronze Plan",
  "description": "Basic version of our software service",
  "grade": 1,
  "startDate": "2025-09-10",
  "endDate": "2043-08-16"
}

Response

OK

idstring

Unique identifier of the Product Rate Plan (PRP).

namestring

Rate plan name.

descriptionstring

Rate plan description.

productIdstring

Owning product ID.

productRatePlanNumberstring

Rate plan number.

startDatestring date

Rate plan effective start date (UTC, YYYY-MM-DD).

endDatestring date

Rate plan effective end date (UTC, YYYY-MM-DD).

statestring

Current rate plan state.

statusstring

Rate plan status.

activeCurrenciesstring[]

Currencies with active pricing.

displayNamestring

Product rate plan display name.

attributesobject[]

Attribute definitions associated with the plan.

contextFiltersobject[]

Context filters at the plan level.

entitlementsobject[]

Entitlements linked to the plan.

externalIdSourceSystemstring

External ID source system.

externalRateplanIdstring[]

External plan identifiers.

netsuiteobject

Netsuite integration attributes.

organizationLabelsstring[]

Organization labels.

customFieldsobject

Custom fields at the plan level.

createTimestring date-time

Plan creation time.

updateTimestring date-time

Plan update time.

createdBystring

ID of the user who created the plan.

updatedBystring

ID of the user who updated the plan.

Example response

{
  "id": "38660706ef2f48cfb5222f7dde491895",
  "name": "Bronze Plan",
  "description": "Basic version of our software service",
  "productId": "8a90aac8948deebf01949098b7790326",
  "productRatePlanNumber": "PRP-00000172",
  "startDate": "2025-09-10",
  "endDate": "2027-01-01",
  "state": "active",
  "status": "ACTIVE",
  "activeCurrencies": [
    "USD"
  ],
  "productRatePlanCharges": [
    {
      "id": "99e226fec45943f4b80ed7bcf6d595d7",
      "name": "disc_currency",
      "chargeType": "recurring",
      "chargeModel": "discount_percentage",
      "listPriceBase": "Per_Billing_Period",
      "triggerEvent": "contract_effective",
      "billCycle": {
        "period": "bill_cycle_period_quarter",
        "periodAlignment": "align_to_term_start",
        "type": "term_start_day"
      },
      "pricing": {
        "discountPercentages": {
          "USD": 10
        },
        "tiers": []
      },
      "taxMode": "non_taxable"
    }
  ],
  "createTime": "2025-02-24T01:20:44.000+00:00",
  "updateTime": "2025-10-23T05:16:28.334+00:00",
  "createdBy": "8a90a2fd8030ea2e018032b11d3a3f06",
  "updatedBy": "53c162482f054f3ca08e1ec82dccfec9"
}

Changes