--- title: "Retrieve a rate plan charge" method: GET path: "/object-query/rate-plan-charges/{key}" tags: ["Object Queries"] --- # Retrieve a rate plan charge `GET /object-query/rate-plan-charges/{key}` Retrieve the details of a specific Rate Plan Charge object. ## Path parameters - `key` string, required ## Query parameters - `pageSize` integer - `cursor` string - `sort[]` string[] - `expand[]` string[] - `filter[]` string[] - `fields[]` string[] - `includeNullFields` boolean ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Response `200` OK - ExpandedRatePlanCharge - `id` string — The unique identifier of the rate plan charge. - `createdById` string — The unique identifier of the user who created the rate plan charge. - `createdDate` string, date-time — The date and time when the rate plan charge was created. - `updatedById` string — The unique identifier of the user who last updated the rate plan charge. - `updatedDate` string, date-time — The date and time when the rate plan charge was last updated. - `ratePlanId` string — The unique identifier of the rate plan to which this rate plan charge belongs. - `productRatePlanChargeId` string — The unique identifier of the product rate plan charge associated with this product rate plan charge. - `accountingCode` string — The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes. **Values**: inherited from `ProductRatePlanCharge.AccountingCode` **Note**: This value changes if `ProductRatePlanCharge.AccountingCode` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.AccountingCode` is updated. - `applyDiscountTo` string — Specifies the type of charges a specific discount applies to. **Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` - `billCycleDay` integer — Indicates the charge's billing cycle day (BCD), which is when bill runs generate invoices for charges associated with the product rate plan charge or the account. **Values**: inherited from `ProductRatePlanCharge.BillCycleDay` - `billCycleType` string — Specifies how to determine the billing day for the charge. **Values**: inherited from `ProductRatePlanCharge.BillCycleType` **Note:** You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `billingPeriod` string — Allows billing period to be overridden on rate plan Charge. **Values**: **inherited from `ProductRatePlanCharge.BillingPeriod` **Note:** You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `billingPeriodAlignment` string — Aligns charges within the same subscription if multiple charges begin on different dates. **Values**: inherited from `ProductRatePlanCharge.BillingPeriodAlignment` - `billingTiming` 'In Advance' | 'In Arrears' — The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types. **Note:** You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type. - `chargedThroughDate` string, date — The date through which a customer has been billed for the charge. - `chargeModel` string — Determines how to evaluate charges. Charge models must be individually activated in the web-based UI. **Values**: inherited from `ProductRatePlanCharge.ChargeModel` - `chargeNumber` string — A unique number that identifies the charge. This number is returned as a string. **Values**: one of the following: - automatically generated if left `null` - a unique number of 50 characters or fewer - `chargeType` string — Specifies the type of charge. **Values**: inherited from `ProductRatePlanCharge.ChargeType` - `description` string — A description of the rate plan charge. - `discountLevel` 'rateplan' | 'subscription' | 'account' — Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge. - `dMRC` number — A delta monthly recurring charge is the change in monthly recurring revenue caused by an amendment or a new subscription. **Character limit**: 16 **Values**: automatically generated - `drawdownRate` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The [conversion rate](https://docs.zuora.com?resourceId=billing-create-drawdown-charge) between Usage UOM and Drawdown UOM for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). Must be a positive number (>0). - `dTCV` number — After an Amendment, the change in the total contract value (TCV) amount for this charge, compared with its previous value. **Character limit**: 16 **Values**: automatically generated - `effectiveEndDate` string, date — Start date when the rate plan charge becomes active, as `yyyy-mm-dd`. - `effectiveStartDate` string, date — Final date the rate plan is active, as `yyyy-mm-dd`. - `endDateCondition` 'SubscriptionEnd' | 'FixedPeriod' | 'SpecificEndDate' | 'OneTime' — Condition for the charge to become inactive. - If the value of this field is `FixedPeriod`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields. - If the value of this field is `SpecificEndDate`, use the `specificEndDate` field to specify the date when the charge becomes inactive. - `estimatedStartDate` string, date — The estimated start date of the pending charge in an active subscription. The value must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. - `estimatedEndDate` string, date — The estimated end date of the pending charge in an active subscription. The system automatically calculates the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. - `excludeItemBillingFromRevenueAccounting` boolean — The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. If both the following features are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in an Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`. * Prepaid with Drawdown * Unbilled Usage **Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — The flag to exclude rate plan charges from revenue accounting. If both the following features are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. * Prepaid with Drawdown * Unbilled Usage **Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `invoiceScheduleId` string — The unique identifier of the invoice schedule associated with the subscription. - `isLastSegment` boolean — Indicates if the segment of the rate plan charge is the most recent segment. **Character limit**: 5 **Values**: automatically generated. - `isPrepaid` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. - `isRollover` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. It determines whether the rollover fields are needed. - `rolloverPeriods` integer — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the number of rollover periods, it is restricted to 3. - `rolloverPeriodLength` integer, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the `rolloverPeriods` field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year. - `rolloverApply` 'ApplyFirst' | 'ApplyLast' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the priority of rollover, which is either first or last. - `isProcessed` boolean — Indicates whether the rate plan charge has been processed. - `listPriceBase` 'Per Billing Period' | 'Per Month' | 'Per Week' | 'Per Year' | 'Per Specific Months' — The list price base for the product rate plan charge. - `specificListPriceBase` integer, nullable — The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`. **Notes**: - This field is available only if you have the Annual List Price feature enabled. - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`. - `priceUpsellQuantityStacked` boolean - `commitmentType` 'UNIT' | 'CURRENCY' — **Note**: This field is only available if you have the Unbilled Usage feature enabled. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. This field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. * If UNIT, it will create a fund with given prepaidUom. * If CURRENCY, it will create a fund with the currency amount calculated in list price. For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges. - `isCommitted` boolean — Indicates whether the rate plan charge is commited. - `mRR` number — Monthly recurring revenue (MRR) is the amount of recurring charges in a given month. The MRR calculation doesn't include one-time charges nor usage charges. **Character limit**: 16 **Values**: automatically generated - `name` string — The name of the rate plan charge. **Character limit**: 100 **Values**: automatically generated - `numberOfPeriods` integer — Specifies the number of periods to use when calculating charges in an overage smoothing charge model. **Character limit**: 5 **Values**: inherited from `ProductRatePlanCharge.NumberOfPeriod` - `originalId` string — The original ID of the rate plan charge. **Character limit**: 32 **Values**: automatically generated - `overageCalculationOption` string — Determines when to calculate overage charges. If the value of the SmoothingMode field is null (not specified and not inherited from ProductRatePlanCharge.SmoothingMode), the value of this field is ignored. **Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.OverageCalculationOption` - `overageUnusedUnitsCreditOption` string — Determines whether to credit the customer with unused units of usage. **Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.OverageUnusedUnitsCreditOption` - `prepaidOperationType` 'topup' | 'drawdown' | 'null', nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The type of this charge. It is either a prepayment (topup) charge or a drawdown charge. - `prepaidQuantity` number, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The number of units included in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). Must be a positive number (>0). - `prepaidTotalQuantity` number, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `priceChangeOption` string — Applies an automatic price change when a termed subscription is renewed. **Values**: one of the following: - `NoChange` (default) - `SpecificPercentageValue` - `UseLatestProductCatalogPricing` - `priceIncreasePercentage` number, double — Specifies the percentage to increase or decrease the price of renewed subscriptions. **Character limit**: 16 **Values**: a decimal value between -100 and 100 - `processedThroughDate` string, date — The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended. **Character limit**: 29 **Values**: automatically generated - `prorationOption` string — Determines how to prorate charges when a subscription is created or amended. - `quantity` number — The default quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing. **Character limit**: 16 **Values**: a valid quantity value - `numberOfDeliveries` number — Number of deliveries in the billing period for the charge segment. The `numberOfDeliveries` is used for the Delivery Pricing charge model only. **Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself) in the Knowledge Center. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**. - `ratingGroup` 'ByBillingPeriod' | 'ByUsageStartDate' | 'ByUsageRecord' | 'ByUsageUpload' | 'ByGroupId' — A rating group based on which usage records are rated. Only applicable to Usage charges. Possible values: - `ByBillingPeriod`: The rating is based on all the usages in a billing period. - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. - `ByUsageRecord`: The rating is based on each usage record. - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`). - `ByGroupId`: The rating is based on all the usages in a custom group. For more information, see [Usage rating by group](https://docs.zuora.com?resourceId=billing-usage-rating-by-group). - `revenueRecognitionRuleName` string — Specifies the Revenue Recognition Rule that you want the Rate Plan Charge to use. This field can be updated when **Status** is `Draft`. By default, the Revenue Recognition Rule is inherited from the Product Rate Plan Charge. For Amend calls, you can use this field only for NewProduct amendments. For Update calls, you can use this field only to update subscriptions in draft status. Note that if you use this field to specify a Revenue Recognition Rule for the Rate Plan Charge, the rule will remain as specified even if you later change the rule used by the corresponding Product Rate Plan Charge. **Character limit**: n/a **Values**: inherited from `ProductRatePlanCharge.RevenueRecognitionRuleName` or the name of an active Revenue Recognition Rule **Note**: Unless overridden, this value changes if `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. - `revenueRecognitionTiming` 'Upon Billing Document Posting Date' | 'Upon Order Activation Date' — Specifies the type of revenue recognition timing. Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI. **Note**: This field is only available if you have the Order to Revenue feature enabled. - `revenueAmortizationMethod` 'Immediate' | 'Ratable Using Start And End Dates' — Specifies the type of revenue amortization method. Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI. **Note**: This field is only available if you have the Order to Revenue feature enabled. - `revRecCode` string — Associates this product rate plan charge with a specific revenue recognition code. **Character limit**: 70 **Values**: inherited from `ProductRatePlanCharge.RevRecCode` or a valid revenue recognition code **Note**: Unless overridden, this value changes if `ProductRatePlanCharge.RevRecCode` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecCode` is updated. - `revRecTriggerCondition` string — Specifies when revenue recognition begins. **Character limit**: 22 **Values**: inherited from `ProductRatePlanCharge.RevRecTriggerCondition` or one of the following: - `ContractEffectiveDate` - `ServiceActivationDate` - `CustomerAcceptanceDate` Note: Unless overridden, this value changes if `ProductRatePlanCharge.RevRecTriggerCondition` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecTriggerCondition` is updated. " - `segment` integer — The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1. **Character limit**: 2 **Values**: automatically generated - `specificBillingPeriod` integer — Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`. **Character limit**: 5 **Values**: inherited from `ProductRatePlanCharge.BillingPeriod` **Note:** You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `specificEndDate` string, date — The specific date on which the charge ends, in `yyyy-mm-dd` format. **Character limit**: 29 **Note**: - This field is only applicable when the `EndDateCondition` field is set to `SpecificEndDate`. - If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date. - `tCV` number, double — The total contract value (TCV) is the value of a single rate plan charge in a subscription over the lifetime of the subscription. This value does not represent all charges on the subscription. The TCV includes recurring charges and one-time charges, but it doesn't include usage charge. **Character limit**: 16 **Values**: automatically generated - `triggerDate` string, date — The date when the charge becomes effective and billing begins, in `yyyy-mm-dd` format. This field is required if the `TriggerEvent` field value is `SpecificDate`. **Character limit**: 29 - `triggerEvent` string — Specifies when to start billing the customer for the charge. **Note: **This field can be passed through the Subscribe and Amend calls and will override the default value set on the Product Rate Plan Charge. **Character limit**: 18 **Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and can be one of the following values: - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed. - `ServiceActivation` is when the services or products for a subscription have been activated and the customers have access. - `CustomerAcceptance` is when the customer accepts the services or products for a subscription. - `SpecificDate` is valid only on the RatePlanCharge. - `uOM` string — Specifies the units to measure usage. **Character limit**: 25 **Values**: inherited from `ProductRatePlanCharge.UOM` - `upToPeriods` integer — Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends. **Character limit**: 5 **Values**: inherited from `ProductRatePlanCharge.UpToPeriods` **Note**: - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`. - You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - Use this field to override the value in `ProductRatePlanCharge.UpToPeriod`. - If you override the value in this field, enter a whole number between 0 and 65535, exclusive. - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. - `upToPeriodsType` 'Billing Periods' | 'Days' | 'Weeks' | 'Months' | 'Years' — The period type used to define when the charge ends. This field can be updated when **Status** is `Draft`. **Note**: - You must use this field together with the `UpToPeriods` field to specify the time period. - This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`. - `version` integer — The version of the rate plan charge. Each time a charge is amended, Zuora creates a new version of the rate plan charge. **Character limit**: 5 **Values**: automatically generated. - `weeklyBillCycleDay` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Specifies which day of the week as the bill cycle day (BCD) for the charge. - `subscriptionId` string — The unique identifier of the subscription to which the rate plan charge belongs. - `subscriptionOwnerId` string — ID of the account that owns the subscription. - `invoiceOwnerId` string — ID of the account that will pay the billing documents for the subscription. - `originalOrderDate` string, date — The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue. - `amendedByOrderOn` string, date — The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. - `validityPeriodType` 'SUBSCRIPTION_TERM' | 'ANNUAL' | 'SEMI_ANNUAL' | 'QUARTER' | 'MONTH' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `creditOption` 'TimeBased' | 'ConsumptionBased' | 'FullCreditBack' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The way to calculate credit. See [Credit Option](https://docs.zuora.com?resourceId=billing-prepayment-charge) for more information. - `applyToBillingPeriodPartially` boolean — Allow the discount duration to be aligned with the billing period partially. **Note**: You must enable the [Enhanced Discounts](https://docs.zuora.com?resourceId=billing-manage-enhanced-discount) feature to access this field. - `productChargeDefinitionId` string — The unique ID of the product charge definition. - `accountReceivableAccountingCodeId` string — ID of the accountReceivableAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled. - `deferredRevenueAccountingCodeId` string — ID of the deferredRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `recognizedRevenueAccountingCodeId` string — ID of the recognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `prepaidUOM` string — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Unit of measurement for a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `drawdownUom` string — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Unit of measurement for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). - `salesPrice` number — The sales price associated with the rate plan charge expressed as a decimal. **Notes**: - This field is only available to subscriptions that are created through orders and exist after 2023-01-10. - This field applies to the following charge models, and the values vary with the charge models: - Flat fee: the value equals the value of the `price` field. - Per unit: the value equals `price` multiplied by `quantity`. - Fixed amount discount: the value equals the value of the `discountAmount` field. - Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit. - Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit. - `taxable` boolean — Indicates whether the rate plan charge is taxable. - `reverted` boolean — Indicates whether the rate plan charge has been reverted. - `reflectDiscountInNetAmount` boolean — Indicates whether the discount is reflected in the net amount. - `ratePlan` NestedRatePlanOnExpand - `id` string — The unique identifier of the rate plan. - `createdById` string — The unique identifier of the user who created the rate plan. - `createdDate` string, date-time — The date and time when the rate plan was created. - `updatedById` string — The unique identifier of the user who last updated the rate plan. - `updatedDate` string, date-time — The date and time when the rate plan was last updated. - `productId` string — The unique identifier of the product associated with the rate plan. - `amendmentId` string — The unique identifier of the amendment made to the subscription. - `amendmentType` string — The type of amendment associated with the rate plan. This field only applies to amendment rate plans. - `name` string — The name of the rate plan. - `productRatePlanId` string — The unique identifier of the product rate plan that the rate plan is based on. - `subscriptionId` string — The unique identifier of the subscription associated with the rate plan. - `subscriptionOwnerId` string — The unique identifier of the account that owns the subscription. - `invoiceOwnerId` string — The unique identifier of the account that will pay the invoice. - `externallyManagedPlanId` string — Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. - `originalRatePlanId` string — The original ID of the subscription rate plan, which is the ID of the subscription rate plan in the version-1 subscription. - `subscriptionOfferId` string — The unique identifier of the subscription offer associated with the rate plan. - `subscriptionRatePlanNumber` string — The number of the rate plan in the subscription. - `subscription` object — The subscription associated with the rate plan. - `productRatePlan` object — The product rate plan associated with the rate plan. - `reverted` boolean — Indicates whether the rate plan has been reverted. - `ratePlanCharges` object[] — The rate plan charges on the rate plan. - `productRatePlanCharge` NestedPrpcOnExpand - `id` string — The unique identifier of the product rate plan charge. - `createdById` string — The unique identifier of the user who created the product rate plan charge. - `createdDate` string, date-time — The date and time when the product rate plan charge was created. - `updatedById` string — The unique identifier of the user who last updated the product rate plan charge. - `updatedDate` string, date-time — The date and time when the product rate plan charge was last updated. - `accountingCode` string — The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes. - `applyDiscountTo` 'ONETIME' | 'RECURRING' | 'USAGE' | 'ONETIMERECURRING' | 'ONETIMEUSAGE' | 'RECURRINGUSAGE' | 'ONETIMERECURRINGUSAGE' | 'null', nullable — Indicates which type of charge the discount charge applies to. - `chargeFunction` 'Standard' | 'Prepayment' | 'CommitmentTrueUp' | 'Drawdown' | 'CreditCommitment' | 'DrawdownAndCreditCommitment' — **Note**: This field is only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled. This field defines what type of charge it is: * Standard: Normal charge with no Prepayment or Commitment or Drawdown. * Prepayment: For recurring charges. Unit or currency based prepaid charge. * CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge. * Drawdown: For usage charges. Drawdown from prepaid funds. * DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds. * CreditCommitment: For usage charges. Credit to minimum commitment funds. - `isAllocationEligible` boolean — Indicates whether the charge segment is allocation eligible in revenue recognition. - `isUnbilled` boolean — Specifies how to perform the accounting during revenue recognition. - `applyToBillingPeriodPartially` boolean — Allow the discount duration to be aligned with the billing period partially. - `billCycleDay` integer — Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object. - `billCycleType` 'DefaultFromCustomer' | 'SpecificDayofMonth' | 'SubscriptionStartDay' | 'ChargeTriggerDay' | 'SpecificDayofWeek' | 'TermStartDay' | 'TermEndDay' — Specifies how to determine the billing day for the charge. - `billingPeriod` 'Month' | 'Quarter' | 'Annual' | 'Semi-Annual' | 'Specific Months' | 'Subscription Term' | 'Week' | 'Specific Weeks' | 'Specific Days' — The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). - `billingPeriodAlignment` 'AlignToCharge' | 'AlignToSubscriptionStart' | 'AlignToTermStart' | 'AlignToTermEnd' — The billing period alignment setting for this charge. - `billingTiming` 'IN_ADVANCE' | 'IN_ARREARS' — The billing timing for this charge. - `chargeModel` 'Discount-Fixed Amount' | 'Discount-Percentage' | 'Flat Fee Pricing' | 'Per Unit Pricing' | 'Overage Pricing' | 'Tiered Pricing' | 'Tiered with Overage Pricing' | 'Volume Pricing' | 'Delivery Pricing' | 'MultiAttributePricing' | 'PreratedPerUnit' | 'PreratedPricing`' | 'HighWatermarkVolumePricing' | 'HighWatermarkTieredPricing' — Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration. - `chargeType` 'OneTime' | 'Recurring' | 'Usage' — Specifies the type of charge. - `creditOption` 'TimeBased' | 'ConsumptionBased' | 'FullCreditBack' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The way to calculate credit. See [Credit Option](https://docs.zuora.com?resourceId=billing-prepayment-charge) for more information. - `defaultQuantity` number, nullable — The default quantity. This field is applicable only for one-time and recurring charges. - `deferredRevenueAccount` string — The name of the deferred revenue account for this charge. This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). - `description` string — Description of the product rate plan charge. - `discountClassId` string, nullable — ID of the class the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied. For more information, see [Manage Discount Classes](https://docs.zuora.com?resourceId=billing-manage-discount-classes). - `discountLevel` 'rateplan' | 'subscription' | 'account' | 'null', nullable — The application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge. - `drawdownRate` number, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The [conversion rate](https://docs.zuora.com?resourceId=billing-create-drawdown-charge) between Usage UOM and Drawdown UOM for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). Must be a positive number (>0). - `endDateCondition` 'SubscriptionEnd' | 'OneTime' | 'FixedPeriod' | 'SpecificEndDate' — The end date condition for this charge. - `excludeItemBillingFromRevenueAccounting` boolean — Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — Indicates whether to exclude the related rate plan charges and order line items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. - `includedUnits` number — Specifies the number of units in the base set of units. - `isPrepaid` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. - `isRollover` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. It determines whether the rollover fields are needed. - `isStackedDiscount` boolean — **Note**: This field is only applicable to the Discount - Percentage charge model. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows: - `True`: This is a stacked discount, which should be calculated by stacking with other discounts. - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts. For more information, see [Stacked discounts](https://docs.zuora.com?resourceId=billing-discount-charge-models). - `legacyRevenueReporting` boolean — Indicates whether to use the legacy revenue reporting for this charge. - `listPriceBase` 'Per Billing Period' | 'Per Month' | 'Per Week' | 'Per Year' | 'Per Specific Months' — The list price base for the product rate plan charge. This field is only applicable for recurring charges. - `specificListPriceBase` integer, nullable — The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. - `maxQuantity` number — The maximum number of units for this charge. This field and the `minQuantity` field can be used to create a range of units allowed in a product rate plan charge. - `minQuantity` number — The minimum number of units for this charge. This field and the `maxQuantity` field can be used to create a range of units allowed in a product rate plan charge. - `name` string — Name of the product rate-plan charge. Not required to be unique. - `numberOfPeriod` integer, nullable — Specifies the number of periods to use when calculating charges in an overage smoothing charge model. This field is ued when overage smoothing model is `RollingWindow` or `Rollover`. - `overageCalculationOption` 'EndOfSmoothingPeriod' | 'PerBillingPeriod' | 'null', nullable — Value specifies when to calculate overage charges. - `overageUnusedUnitsCreditOption` 'NoCredit' | 'CreditBySpecificRate', nullable — Determines whether to credit the customer with unused units of usage. - `prepaidOperationType` 'topup' | 'drawdown' | 'null', nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The type of this charge. It is either a prepayment (topup) charge or a drawdown charge. - `prepaidQuantity` number, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The number of units included in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). Must be a positive number (>0). - `prepaidTotalQuantity` number, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `priceChangeOption` 'NoChange' | 'SpecificPercentageValue' | 'UseLatestProductCatalogPricing', nullable — Applies an automatic price change when a termed subscription is renewed and the following applies: 1. AutomatedPriceChange setting is on 2. Charge type is not one-time 3. Charge model is not discount fixed amount - `priceIncreasePercentage` number, nullable — Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `PriceChangeOption` value to `SpecificPercentageValue`. 1. AutomatedPriceChange setting is on 2. Charge type is not one-time 3. Charge model is not discount fixed amount Values: a decimal between -100 and 100 - `productRatePlanChargeNumber` string — The natural key of the product rate plan charge. - `prorationOption` string — **Note**: This field is only available if you have the Charge Level Proration feature enabled. The charge-level proration option for the product rate plan charge. - `ratingGroup` string, nullable — Specifies a rating group based on which usage records are rated. Possible values: - `ByBillingPeriod` (default): The rating is based on all the usages in a billing period. - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. - `ByUsageRecord`: The rating is based on each usage record. - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`). - `ByGroupId`: The rating is based on all the usages in a custom group. **Note:** - The `ByBillingPeriod` value can be applied for all charge models. - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. - The `ByGroupId` value is only available if you have the Active Rating feature enabled. - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`. - `revRecTriggerCondition` 'ContractEffectiveDate' | 'ServiceActivationDate' | 'CustomerAcceptanceDate' | 'null', nullable — Specifies when revenue recognition begins. - `revenueRecognitionRuleName` string — The name of the revenue recognition rule governing the revenue schedule. - `rolloverApply` 'ApplyFirst' | 'ApplyLast' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the priority of rollover, which is either first or last. - `rolloverPeriodLength` integer — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The period length of the rollover fund. - `rolloverPeriods` integer — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the number of rollover periods, it is restricted to 3. - `recognizedRevenueAccount` string — The name of the recognized revenue account for this charge. - Required when the Allow Blank Accounting Code setting is No. - Optional when the Allow Blank Accounting Code setting is Yes. This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). - `smoothingModel` string, nullable — Specifies the smoothing model for an overage smoothing charge model or an tiered with overage model, which is an advanced type of a usage model that avoids spikes in usage charges. If a customer's usage spikes in a single period, then an overage smoothing model eases overage charges by considering usage and multiple periods. One of the following values shows which smoothing model will be applied to the charge when `Overage` or `Tiered with Overage` is used: - `RollingWindow` considers a number of periods to smooth usage. The rolling window starts and increments forward based on billing frequency. When allowed usage is met, then period resets and a new window begins. - `Rollover` considers a fixed number of periods before calculating usage. The net balance at the end of a period is unused usage, which is carried over to the next period's balance. - `specificBillingPeriod` integer, nullable — When the billing period is set to `Specific` Months then this positive integer reflects the number of months for billing period charges. - `taxable` boolean — Specifies whether the charge is taxable; used by Zuora Tax. - `taxCode` string — Specifies the tax code for taxation rules; used by Zuora Tax. - `taxMode` 'TaxExclusive' | 'TaxInclusive' | 'null', nullable — Specifies how to define taxation for the charge; used by Zuora Tax. - `triggerEvent` 'ContractEffective' | 'ServiceActivation' | 'CustomerAcceptance' | 'SpecificDate' — Specifies when to start billing the customer for the charge. Values: one of the following: - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed. - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access. - `CustomerAcceptance` is when the customer accepts the services or products for a subscription. - `SpecificDate` is the date specified. - `upToPeriods` integer, nullable — Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends. If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. - `upToPeriodsType` 'Billing Periods' | 'Days' | 'Weeks' | 'Months' | 'Years' | 'null', nullable — The period type used to define when the charge ends. - `usageRecordRatingOption` string, nullable — Determines how Zuora processes usage records for per-unit usage charges. - `useDiscountSpecificAccountingCode` boolean, nullable — Determines whether to define a new accounting code for the new discount charge. - `useTenantDefaultForPriceChange` boolean — Shows the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. You set the tenant uplift value in the web-based UI: **Settings > Billing > Define Default Subscription Settings**. - `validityPeriodType` 'SubscriptionTerm' | 'Annual' | 'SemiAnnual' | 'Quarter' | 'Month' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `weeklyBillCycleDay` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Specifies which day of the week as the bill cycle day (BCD) for the charge. This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). - `priceUpsellQuantityStacked` boolean — Indicates whether the price upsell quantity is stacked. - `deliveryScheduleId` string — The unique identifier of the delivery schedule associated with the product rate plan charge. This field is applicable only when this charge is using Delivery Pricing charge model. - `commitmentType` 'UNIT' | 'CURRENCY' — **Note**: This field is only available if you have the Unbilled Usage feature enabled. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. This field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. * If UNIT, it will create a fund with given prepaidUom. * If CURRENCY, it will create a fund with the currency amount calculated in list price. For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges. - `isCommitted` boolean — Indicates whether the charge is commited. - `productRatePlanId` string — The unique identifier of the product rate plan to which this product rate plan charge belongs. - `accountReceivableAccountingCodeId` string — The type of the accounting code for accounts receivable. - `recognizedRevenueAccountingCodeId` string — The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges. - `deferredRevenueAccountingCodeId` string, nullable — The type associated with the deferred revenue accounting code, such as Deferred Revenue. - `adjustmentLiabilityAccountingCodeId` string — The type associated with the adjustment liability accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `adjustmentRevenueAccountingCodeId` string — The type associated with the adjustment revenue accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractAssetAccountingCodeId` string — The type associated with the contract asset accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractLiabilityAccountingCodeId` string — The accounting code for contract liability. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractRecognizedRevenueAccountingCodeId` string — The accounting code for contract recognized revenue. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `unbilledReceivablesAccountingCodeId` string, nullable — The accounting code for unbilled receivables. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `revRecCode` string, nullable — Associates this product rate plan charge with a specific revenue recognition code. - `uOM` string, nullable — Describes the Units of Measure (uom) configured in **Settings > Billing** for the productRatePlanCharges. - `drawdownUom` string — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Unit of measurement for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). - `prepaidUom` string, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Unit of measurement for a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `productRatePlan` object — The product rate plan that contains this product rate plan charge. - `productRatePlanChargeTiers` object[] — The product rate plan charge tiers contained in this product rate plan charge. ## Other responses - `500` — Internal server error - `4XX` — Invalid input --- [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)