# 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.

Endpoint: PUT /commerce/plans
Version: 2026-02-20
Security: bearerAuth

## Header parameters:

  - `Accept-Encoding` (string)
    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-Encoding` (string)
    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-Id` (string)
    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-Ids` (string)
    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-Ids` (string)
    Comma separated IDs. If you have Zuora Multi-Org 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 fields (application/json):

  - `id` (string, required)
    Unique identifier of the Product Rate Plan to update.
    Example: "5758b1d5a589840e0e6855e1c2ce014d"

  - `name` (string)
    Rate plan name.
    Example: "Bronze Plan"

  - `description` (string)
    Rate plan description.
    Example: "Basic version of our software service"

  - `grade` (integer)
    Plan grade or display rank used for ordering in catalogs or UIs.
    Example: 1

  - `startDate` (string)
    Rate plan effective start date (UTC, YYYY-MM-DD).
    Example: "2025-09-10"

  - `endDate` (string)
    Rate plan effective end date (UTC, YYYY-MM-DD).
    Example: "2043-08-16"

## Response 200 fields (application/json):

  - `id` (string)
    Unique identifier of the Product Rate Plan (PRP).
    Example: "38660706ef2f48cfb5222f7dde491895"

  - `name` (string)
    Rate plan name.
    Example: "Bronze Plan"

  - `description` (string)
    Rate plan description.
    Example: "Basic version of our software service"

  - `productId` (string)
    Owning product ID.
    Example: "8a90aac8948deebf01949098b7790326"

  - `productRatePlanNumber` (string)
    Rate plan number.
    Example: "PRP-00000172"

  - `startDate` (string)
    Rate plan effective start date (UTC, YYYY-MM-DD).
    Example: "2025-09-10"

  - `endDate` (string)
    Rate plan effective end date (UTC, YYYY-MM-DD).
    Example: "2027-01-01"

  - `state` (string)
    Current rate plan state.
    Example: "active"

  - `status` (string)
    Rate plan status.
    Example: "ACTIVE"

  - `activeCurrencies` (array)
    Currencies with active pricing.
    Example: ["USD"]

  - `displayName` (string)
    Product rate plan display name.

  - `attributes` (array)
    Attribute definitions associated with the plan.

  - `contextFilters` (array)
    Context filters at the plan level.

  - `entitlements` (array)
    Entitlements linked to the plan.

  - `externalIdSourceSystem` (string)
    External ID source system.

  - `externalRateplanId` (array)
    External plan identifiers.

  - `netsuite` (object)
    Netsuite integration attributes.

  - `organizationLabels` (array)
    Organization labels.

  - `customFields` (object)
    Custom fields at the plan level.

  - `productRatePlanCharges` (array)
    Charges (PRPCs) that belong to this product rate plan.

  - `productRatePlanCharges.id` (string)
    Unique identifier of the Product Rate Plan Charge (PRPC).
    Example: "99e226fec45943f4b80ed7bcf6d595d7"

  - `productRatePlanCharges.name` (string)
    Charge name.
    Example: "disc_currency"

  - `productRatePlanCharges.chargeType` (string)
    Charge type.
    Example: "recurring"

  - `productRatePlanCharges.chargeModel` (string)
    Charge model.
    Example: "discount_percentage"

  - `productRatePlanCharges.listPriceBase` (string)
    Indicates how list price is interpreted.
    Example: "Per_Billing_Period"

  - `productRatePlanCharges.triggerEvent` (string)
    Event that triggers the charge.
    Example: "contract_effective"

  - `productRatePlanCharges.billCycle` (object)
    Billing cycle configuration.
    Example: {"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","type":"term_start_day"}

  - `productRatePlanCharges.pricing` (object)
    Pricing configuration for the charge.
    Example: {"discountPercentages":{"USD":10},"tiers":[]}

  - `productRatePlanCharges.prepayment` (object)
    Prepayment options for the charge (when applicable).

  - `productRatePlanCharges.taxMode` (string)
    Tax mode for this charge, for example, non_taxable or taxable.
    Example: "non_taxable"

  - `productRatePlanCharges.taxable` (boolean)
    Indicates whether the charge is taxable.

  - `productRatePlanCharges.createdById` (string)
    ID of the user who created the charge.

  - `productRatePlanCharges.createdTime` (string)
    Timestamp when the charge was created.

  - `productRatePlanCharges.updatedById` (string)
    ID of the user who last updated the charge.

  - `productRatePlanCharges.updatedTime` (string)
    Timestamp when the charge was last updated.

  - `productRatePlanCharges.accounting` (object)
    Accounting configuration for the charge (for example, account mappings and posting preferences).

  - `productRatePlanCharges.attributes` (array)
    Attribute definitions bound to this charge (used for dynamic pricing or evaluation).

  - `productRatePlanCharges.customFields` (object)
    Custom fields on the charge.

  - `productRatePlanCharges.deliverySchedule` (object)
    Delivery schedule settings, for example, frequency and applicable days.

  - `productRatePlanCharges.discountOptions` (object)
    Discount configuration for this charge, including scope, stacking, and net-amount reflection.

  - `productRatePlanCharges.drawdown` (object)
    Drawdown configuration for consuming balances or entitlements.

  - `productRatePlanCharges.endDateCondition` (string)
    Defines when the charge ends, for example, subscription_end or after a term.

  - `productRatePlanCharges.extendedPrice` (object)
    Calculated extended price details, if applicable.

  - `productRatePlanCharges.isChargeLevelMinCommit` (boolean)
    Indicates whether a minimum commitment is enforced at the charge level.

  - `productRatePlanCharges.isCommitted` (boolean)
    Indicates whether this charge is part of a committed contract.

  - `productRatePlanCharges.labels` (object)
    Key-value metadata labels associated with the charge.

  - `productRatePlanCharges.mergedRateCards` (array)
    Effective rate card entries after merging default and negotiated cards.

  - `productRatePlanCharges.negotiatedRateCards` (array)
    Customer- or segment-specific negotiated rate card entries.

  - `productRatePlanCharges.ocmJsonByCurrency` (object)
    Per-currency pricing/configuration metadata in JSON format.

  - `productRatePlanCharges.organizationLabels` (array)
    Organization labels attached to the charge.

  - `productRatePlanCharges.overageOptions` (object)
    Overage configuration, for example, included units and unused-unit credit rates.

  - `productRatePlanCharges.prepaid` (boolean)
    Indicates whether the charge is prepaid.

  - `productRatePlanCharges.priceChangeOption` (string)
    How price changes are handled on updates, for example, no_change.

  - `productRatePlanCharges.pricingSummary` (array)
    Human-readable pricing summary lines.

  - `productRatePlanCharges.pricingWaterfalls` (object)
    Pricing source breakdown, for example, base price vs. segment price.

  - `productRatePlanCharges.productChargeDefinitions` (array)
    Charge definition objects that specify pricing and behavioral rules.

  - `productRatePlanCharges.productRatePlanChargeNumber` (string)
    Charge number (PRPC number) for this charge.

  - `productRatePlanCharges.productRatePlanId` (string)
    Owning Product Rate Plan ID.

  - `productRatePlanCharges.prorationOption` (string)
    Proration behavior for this charge.

  - `productRatePlanCharges.rateCards` (array)
    Associated rate card definitions used for dynamic or segmented pricing.

  - `productRatePlanCharges.revenue` (object)
    Revenue recognition configuration, for example, rules and codes.

  - `productRatePlanCharges.taxCode` (string)
    Tax code applied to the charge for taxation purposes.

  - `createTime` (string)
    Plan creation time.
    Example: "2025-02-24T01:20:44.000+00:00"

  - `updateTime` (string)
    Plan update time.
    Example: "2025-10-23T05:16:28.334+00:00"

  - `createdBy` (string)
    ID of the user who created the plan.
    Example: "8a90a2fd8030ea2e018032b11d3a3f06"

  - `updatedBy` (string)
    ID of the user who updated the plan.
    Example: "53c162482f054f3ca08e1ec82dccfec9"

## Response 400 fields (application/json):

  - `processId` (string)
    The ID of the process that handles the operation.

  - `reasons` (array)
    The container of the error code and message. This field is available only if the success field is false.

  - `reasons.code` (string)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response

  - `requestId` (string)
    Unique identifier of the request.

  - `success` (boolean)
    Indicates whether the call succeeded.

## Response 401 fields (application/json):

  - `message` (string)
    Error message.

If the error message is "Authentication error", ensure that the Authorization request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/docs/guides/authentication/) for more information.

If the error message is "Failed to get user info", retry the request.

## Response 500 fields (application/json):

  - `reasons` (array)
    Example: [{"code":"ObjectNotFound","message":"Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist"}]

  - `reasons.code` (string)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response