---
title: "Query product rate plan details"
method: POST
path: "/commerce/plans/query"
tags: ["Commerce"]
---

# Query product rate plan details

`POST /commerce/plans/query`

Retrieve details of a **single** product rate plan (PRP) from the Product Catalog. You can expand associated product rate plan charges for each plan.
This operation is a **strict lookup** and **requires** `product_rate_plan_key`. It does **not** support `attributes` or other list-style filters.
To browse or filter plans (including by `attributes`), use  the "Query product rate plans" operation (`POST /commerce/plans/list`).

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Request body

- QueryChargeRequest — Request schema for querying a specific Product Rate Plan Charge (PRPC) by key. Use this operation to fetch details of a single PRP, optionally expanding related charges.
  - `product_rate_plan_key` string — Unique identifier (key) of the Product Rate Plan (PRP) to query. This can be the PRP ID or the PRP number configured in your system.
  - `expand` object — Optional flags to expand related resources in the response.
    - `product_rate_plan_charges` boolean — Whether to include Product Rate Plan Charges (PRPCs) in the response.
  - `attributes` object[] — Optional attribute values to use when evaluating Dynamic Pricing for the PRP or its charges. All required attributes must be supplied if the PRP or PRPC is configured to require them.
    - `name` string, required — Attribute name, for example, Age, Region, EffectiveDate, AccountContext.
    - `value` string — Attribute value used for price evaluation. The value can be a string, number, or boolean, depending on the attribute type. - Enclose the value in quotation marks ("") if it is a **string**, for example, "Liquidity Provider", "Y", "External". - Do **not** use quotation marks for **numeric** or **boolean** values, for example, 98, 5, true, false.
  - `evaluation_level` 'LIST_PRICE' | 'EXTENDED_PRICE' — Controls how pricing is evaluated for the charge. Supported values: - `LIST_PRICE`: evaluate pricing at the list-price level. - `EXTENDED_PRICE`: evaluate pricing at the extended-price level. If not specified, the default is `LIST_PRICE`.

## Response `200`

OK

- CreateChargeResponse
  - `accounting` AccountingResponse — Accounting fields returned by the API. `*Type` fields are derived from the tenant's chart of accounts and are read-only.
    - `accountingCode` string — An accounting code associated with the charge for reporting or ERP mapping. Typically a short code or identifier, not the GL account name.
    - `accountsReceivableAccount` string — Accounts Receivable (AR) account to book invoices for this charge. Must match an existing account in the tenant's chart of accounts.
    - `accountsReceivableAccountType` string — System-derived type/category of the AR account from the chart of accounts. Examples include "AccountsReceivable".
    - `adjustmentLiabilityAccount` string — The name of the account where the Account Type is "Adjustment Liability".
    - `adjustmentLiabilityAccountType` string — System-derived type/category of the Adjustment Liability account from the chart of accounts. Examples include "AdjustmentLiability".
    - `adjustmentRevenueAccount` string — The name of the account where the Account Type is "Adjustment Revenue".
    - `adjustmentRevenueAccountType` string — System-derived type/category of the Adjustment Revenue account from the chart of accounts. Examples include "AdjustmentRevenue".
    - `contractAssetAccount` string — The name of the account where the Account Type is "Contract Asset".
    - `contractAssetAccountType` string — System-derived type/category of the Contract Asset account from the chart of accounts.
    - `contractLiabilityAccount` string — The name of the account where the Account Type is "Contract Liability".
    - `contractLiabilityAccountType` string — System-derived type/category of the Contract Liability account from the chart of accounts. Examples include "ContractLiability".
    - `contractRecognizedRevenueAccount` string — Recognized revenue account used specifically for contract-based recognition flows. Must match an existing account in the tenant's chart of accounts.
    - `contractRecognizedRevenueAccountType` string — System-derived type/category of the Contract Recognized Revenue account from the chart of accounts.
    - `deferredRevenueAccount` string — Deferred revenue (liability) account to book revenue before recognition. Must match an existing account in the tenant's chart of accounts.
    - `deferredRevenueAccountType` string — System-derived type/category of the Deferred Revenue account from the chart of accounts.
    - `recognizedRevenueAccount` string — The name of the account where the Account Type is "Recognized Revenue".
    - `recognizedRevenueAccountType` string — System-derived type/category of the Recognized Revenue account from the chart of accounts.
    - `unbilledReceivablesAccount` string — The name of the account where the Account Type is "Unbilled Receivables".
    - `unbilledReceivablesAccountType` string — System-derived type/category of the Unbilled Receivables account from the chart of accounts.
    - `productRatePlanChargeId` string — The ID of your product rate plan charge.
  - `attributes` object[] — Attribute metadata associated with Dynamic Pricing for this charge.
  - `billCycle` object
    - `dayOfMonth` integer — Specific day of month to bill when type = specific_day_of_month.
    - `period` string — Billing period length.
    - `periodAlignment` string — How the billing period start aligns.
    - `timing` string — Whether the charge bills before or after the service period.
    - `type` string — Bill-cycle mode (inherit defaults or set specific day rules).
  - `chargeFunction` 'charge_function_standard' | 'charge_function_prepayment' | 'charge_function_commitment_true_up' | 'charge_function_drawdown' | 'charge_function_credit_commitment' | 'charge_function_drawdown_and_credit_commitment' — Internal function/category of the charge used by rating.
  - `chargeModel` string — Pricing model that determines how the amount is calculated.
  - `chargeType` string — Whether the charge recurs, rates usage, or is a one-time fee.
  - `createdById` string — User ID that created the charge record.
  - `createdTime` string, date-time — Timestamp when the charge record was created.
  - `customFields` object — Tenant-specific custom field values on the charge.
  - `deliverySchedule` object — Day-of-week delivery settings when delivery scheduling is enabled.
    - `frequency` string — Delivery frequency label for schedule rules.
    - `friday` boolean — Deliver on Friday.
    - `monday` boolean — Deliver on Monday.
    - `saturday` boolean — Deliver on Saturday.
    - `sunday` boolean — Deliver on Sunday.
    - `thursday` boolean — Deliver on Thursday.
    - `tuesday` boolean — Deliver on Tuesday.
    - `wednesday` boolean — Deliver on Wednesday.
  - `discountOptions` object — How discount charges apply and interact with other discounts.
    - `applyDetails` object[] — Per-target discount application details (if populated).
    - `applyTo` string[] — Which components or charges the discount applies to.
    - `applyToBillingPeriodPartially` boolean — Whether the discount duration can partially align to a period.
    - `reflectDiscountInNetAmount` boolean — Whether discounts reduce the net amount on invoices.
    - `rollover` boolean — Whether unused discount can roll over to future periods.
    - `stackedDiscount` boolean — Whether this discount stacks with other discounts.
  - `drawdown` object — Drawdown configuration for the charge when using prepaid with drawdown.
    - `unitOfMeasure` string — Unit of measure used for drawdown consumption. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `conversionRate` number, double — Conversion rate used when converting usage or rated amounts into the drawdown unit of measure. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
  - `endDateCondition` string — Rule for when the charge ends.
  - `upToPeriodsType` string — Unit used for the fixed period when `endDateCondition` is `fixed_period`, for example, billing periods or days.
  - `upToPeriods` integer — Number of periods, in units of `upToPeriodsType`, that the charge remains active when `endDateCondition` is `fixed_period`.
  - `extendedPrice` object — Calculated extended price details (model-dependent).
  - `id` string — Unique identifier of the product rate plan charge (PRPC).
  - `isChargeLevelMinCommit` boolean — Whether a minimum commit is enforced at the charge level.
  - `isCommitted` boolean — Indicates if the charge definition is committed/finalized.
  - `labels` object — Free-form labels/tags attached to the charge.
  - `listPriceBase` string — List price basis, for example, Per Billing Period, Per Month, Per Year.
  - `specificListPriceBase` integer — The number of months for the list price base of the charge. This field is required when the `ListPriceBase` field is set to `Per Specific Months`. The value must be a positive integer between **1** and **120**, inclusive. **Notes**: - This field is available only if you have the Annual List Price feature enabled. - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
  - `mergedRateCards` object[] — Effective rate-card rows after merges (if any).
  - `name` string — Display name of the charge in the plan.
  - `negotiatedRateCards` object[] — Customer- or deal-specific rate-card rows applied by negotiation.
  - `netsuite` object — NetSuite integration attributes mapped for this charge.
  - `ocmJsonByCurrency` object — Offer/OCM metadata keyed by currency (internal use).
  - `organizationLabels` string[] — Organization-level labels associated with the charge.
  - `overageOptions` object — Overage settings for usage charges.
    - `includedUnits` number — Included units before overage starts.
    - `unusedUnitsCreditRates` object — Credit rates for unused units (by currency).
  - `prepaid` boolean — Indicates whether the charge is prepaid.
  - `prepaymentUnitType` 'unit' | 'currency' — Unit type used for the prepayment charge.
  - `prepayment` object — Prepayment configuration for the charge, including credit, operation, quantity, validity period, rollover, and drawdown settings.
    - `creditOption` 'time_based' | 'consumption_based' | 'full_credit_back' | 'credit_option_unspecified' — How prepayment credits are applied (if supported).
    - `operationType` 'prepaid_operation_type_topup' — Type of prepayment operation.
    - `quantity` number, double — Number of units included in the prepayment charge.
    - `rollover` boolean — Whether unused prepayment funds roll over.
    - `rolloverApply` 'apply_first' | 'apply_last' — Specifies whether rollover funds are consumed before or after normal funds.
    - `rolloverPeriodLength` integer — Length of each rollover period.
    - `rolloverPeriods` integer — Number of rollover periods allowed.
    - `unitOfMeasure` string — Unit of measure for the prepayment charge.
    - `validityPeriod` 'subscription_term' | 'annual' | 'semi_annual' | 'quarter' | 'month' | 'specific_days' | 'specific_weeks' | 'specific_months' — Period during which prepayment units are valid. When enhanced unit-based Prepaid with Drawdown is enabled, specific days, specific weeks, and specific months are supported. When using a specific validity period, specify the `specificValidityPeriodLength` field.
    - `validityPeriodAlignment` 'vp_alignment_charge_start' | 'vp_alignment_term_start' | 'vp_alignment_term_end' — Alignment point used to determine the start of the validity period. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `validityPeriodProrationOption` 'vp_proration_option_prorate_units' | 'vp_proration_option_no_prorate' — Specifies whether the validity period is prorated. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `specificValidityPeriodLength` integer — Length of the validity period when a specific validity period is used. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `rolloverPeriodType` 'rollover_period_type_day' | 'rollover_period_type_month' | 'rollover_period_type_quarter' | 'rollover_period_type_annual' — Unit of time used for the rollover period. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `rolloverFundPriority` integer — Priority assigned to rolled-over funds. Lower values are consumed first. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `rolloverEndDateType` 'rollover_end_date_type_charge_end_date' | 'rollover_end_date_type_subscription_term' — Determines when rolled-over funds expire. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `fundSupportAccountHierarchy` boolean — Whether child accounts can consume drawdown funds from the parent account. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `drawdownPriority` integer — Priority used to determine the order in which drawdown funds are consumed. Lower values are consumed first. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
    - `drawdownScope` 'commitment_level_subscription' | 'commitment_level_account' — Scope at which drawdown funds are tracked and consumed. This field replaces the deprecated `commitmentLevel` field. **Note**: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.
  - `priceChangeOption` string — How price changes are applied across renewals/amendments.
  - `pricing` object — Default (charge-level) price configuration by model/currency.
    - `adjustments` object — Price adjustments metadata.
    - `discountAmounts` object — Fixed discount amounts by currency.
    - `discountPercentages` object — Percentage discount values by currency.
    - `flatAmounts` object — Flat amounts by currency for flat-fee pricing.
    - `maxAmounts` object — Maximum caps by currency.
    - `minAmounts` object — Minimum charges by currency.
    - `percentages` object — Percentage price values by currency (model-dependent).
    - `tiers` object[] — Tier definitions for tiered/volume pricing.
    - `unitAmounts` object — Per-unit amounts by currency for per-unit/usage pricing.
  - `pricingSummary` string[] — Human-readable price summary strings, for example, USD100.
  - `pricingWaterfalls` object — Detailed pricing/waterfall breakdown (if available).
  - `productChargeDefinitions` object[] — Underlying charge definitions referenced for pricing lookup.
  - `productRatePlanChargeNumber` string — PRPC number.
  - `productRatePlanId` string — ID of the plan (PRP) that owns this charge.
  - `prorationOption` string — How proration is handled relative to tenant defaults.
  - `rateCards` object[] — Dynamic Pricing rate-card rows configured on the charge.
  - `revenue` object — Revenue policy settings for this charge.
    - `excludeItemBillingFromRevenueAccounting` boolean — If true, item billing is excluded from revenue accounting.
    - `excludeItemBookingFromRevenueAccounting` boolean — If true, item booking is excluded from revenue accounting.
    - `legacyReporting` boolean — Indicator for legacy revenue reporting behaviors.
    - `revenueRecognitionRuleName` string — Name of the revenue rule to apply, for example, "Recognize upon invoicing".
  - `taxCode` string — Tax code applied to the charge (for example, a tax category code).
  - `taxMode` string — Tax mode for the charge.
  - `taxable` boolean — Whether the charge is taxable.
  - `triggerEvent` string — Event that triggers the charge.
  - `unitOfMeasure` string — Unit of measure used for pricing (for example, Each, Seats).
  - `updatedById` string — User ID that last updated the charge record.
  - `updatedTime` string, date-time — Timestamp when the charge record was last updated.
  - `useTenantDefaultForPriceChange` boolean — Whether tenant defaults govern price change behavior.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)