Object Queries

Retrieve a rate plan charge

Retrieve the details of a specific Rate Plan Charge object.

get/object-query/rate-plan-charges/{key}

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/object-query/rate-plan-charges/{key}
  • Auth: HTTP bearer

Path parameters

keystring required

ID of a rate plan charge.

Query parameters

pageSizeinteger

The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

expand[]string[]

Allows you to expand responses by including related object information in a single call.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

idstring

The unique identifier of the rate plan charge.

createdByIdstring

The unique identifier of the user who created the rate plan charge.

createdDatestring date-time

The date and time when the rate plan charge was created.

updatedByIdstring

The unique identifier of the user who last updated the rate plan charge.

updatedDatestring date-time

The date and time when the rate plan charge was last updated.

ratePlanIdstring

The unique identifier of the rate plan to which this rate plan charge belongs.

productRatePlanChargeIdstring

The unique identifier of the product rate plan charge associated with this product rate plan charge.

accountingCodestring

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.

applyDiscountTostring

Specifies the type of charges a specific discount applies to.

Values: inherited from ProductRatePlanCharge.ApplyDiscountTo

billCycleDayinteger

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

billCycleTypestring

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.

billingPeriodstring

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.

billingPeriodAlignmentstring

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.

chargedThroughDatestring date

The date through which a customer has been billed for the charge.

chargeModelstring

Determines how to evaluate charges. Charge models must be individually activated in the web-based UI.

Values: inherited from ProductRatePlanCharge.ChargeModel

chargeNumberstring

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
chargeTypestring

Specifies the type of charge.

Values: inherited from ProductRatePlanCharge.ChargeType

descriptionstring

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.

dMRCnumber

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

drawdownRatenumber

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. Must be a positive number (>0).

dTCVnumber

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

effectiveEndDatestring date

Start date when the rate plan charge becomes active, as yyyy-mm-dd.

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

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

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

excludeItemBillingFromRevenueAccountingboolean

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 <a href="https://docs.zuora.com?resourceId=billing-order-to-revenue" target="_blank">Order to Revenue</a> or Zuora Billing - Revenue Integration feature enabled.

excludeItemBookingFromRevenueAccountingboolean

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 <a href="https://docs.zuora.com?resourceId=billing-order-to-revenue" target="_blank">Order to Revenue</a> or Zuora Billing - Revenue Integration feature enabled.

invoiceScheduleIdstring

The unique identifier of the invoice schedule associated with the subscription.

isLastSegmentboolean

Indicates if the segment of the rate plan charge is the most recent segment.

Character limit: 5 Values: automatically generated.

isPrepaidboolean

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

Indicates whether this charge is a prepayment (topup) charge or a drawdown charge.

isRolloverboolean

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

It determines whether the rollover fields are needed.

rolloverPeriodsinteger

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

This field defines the number of rollover periods, it is restricted to 3.

rolloverPeriodLengthinteger nullable

Note: This field is only available if you have the Prepaid with Drawdown 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 feature enabled.

This field defines the priority of rollover, which is either first or last.

isProcessedboolean

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.

specificListPriceBaseinteger 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 <a href="https://docs.zuora.com?resourceId=billing-annual-list-price" target="_blank">Annual List Price</a> feature enabled.
  • The value of this field is null if you do not set the value of the ListPriceBase field to Per Specific Months.
priceUpsellQuantityStackedboolean
commitmentType'UNIT' | 'CURRENCY'

Note: This field is only available if you have the <a href="https://docs.zuora.com?resourceId=billing-unbilled-usage" target="_blank">Unbilled Usage</a> 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.

isCommittedboolean

Indicates whether the rate plan charge is commited.

mRRnumber

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

namestring

The name of the rate plan charge.

Character limit: 100 Values: automatically generated

numberOfPeriodsinteger

Specifies the number of periods to use when calculating charges in an overage smoothing charge model.

Character limit: 5 Values: inherited from ProductRatePlanCharge.NumberOfPeriod

originalIdstring

The original ID of the rate plan charge.

Character limit: 32 Values: automatically generated

overageCalculationOptionstring

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

overageUnusedUnitsCreditOptionstring

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 feature enabled.

The type of this charge. It is either a prepayment (topup) charge or a drawdown charge.

prepaidQuantitynumber nullable

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The number of units included in a prepayment charge. Must be a positive number (>0).

prepaidTotalQuantitynumber nullable

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge.

priceChangeOptionstring

Applies an automatic price change when a termed subscription is renewed.

Values: one of the following:

  • NoChange (default)
  • SpecificPercentageValue
  • UseLatestProductCatalogPricing
priceIncreasePercentagenumber double

Specifies the percentage to increase or decrease the price of renewed subscriptions.

Character limit: 16 Values: a decimal value between -100 and 100

processedThroughDatestring 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

prorationOptionstring

Determines how to prorate charges when a subscription is created or amended.

quantitynumber

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

numberOfDeliveriesnumber

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

revenueRecognitionRuleNamestring

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 <a href="https://docs.zuora.com?resourceId=billing-configure-revenue-settings" target="_blank">revenue recognition policy configuration</a> 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 <a href="https://docs.zuora.com?resourceId=billing-configure-revenue-settings" target="_blank">revenue recognition policy configuration</a> in the Zuora Billing UI.

Note: This field is only available if you have the Order to Revenue feature enabled.

revRecCodestring

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.

revRecTriggerConditionstring

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

segmentinteger

The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1.

Character limit: 2 Values: automatically generated

specificBillingPeriodinteger

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.

specificEndDatestring 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.
tCVnumber 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

triggerDatestring 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

triggerEventstring

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

Specifies the units to measure usage.

Character limit: 25 Values: inherited from ProductRatePlanCharge.UOM

upToPeriodsinteger

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

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.

subscriptionIdstring

The unique identifier of the subscription to which the rate plan charge belongs.

subscriptionOwnerIdstring

ID of the account that owns the subscription.

invoiceOwnerIdstring

ID of the account that will pay the billing documents for the subscription.

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

amendedByOrderOnstring 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 feature enabled.

The period in which the prepayment units are valid to use as defined in a prepayment charge.

creditOption'TimeBased' | 'ConsumptionBased' | 'FullCreditBack'

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The way to calculate credit. See Credit Option for more information.

applyToBillingPeriodPartiallyboolean

Allow the discount duration to be aligned with the billing period partially.

Note: You must enable the Enhanced Discounts feature to access this field.

productChargeDefinitionIdstring

The unique ID of the product charge definition.

accountReceivableAccountingCodeIdstring

ID of the accountReceivableAccountingCode of a standalone charge.

Note: This field is available when the <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders" target="_blank">Standalone Orders</a>, <a href="https://docs.zuora.com?resourceId=ar-zuora-finance" target="_blank">Zuora Finance</a>, and <a href="https://docs.zuora.com?resourceId=billing-invoice-settlement" target="_blank">Invoice Settlement</a> features are enabled.

deferredRevenueAccountingCodeIdstring

ID of the deferredRevenueAccountingCode of a standalone charge.

Note: This field is available when the <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders" target="_blank">Standalone Orders</a> and <a href="https://docs.zuora.com?resourceId=ar-zuora-finance" target="_blank">Zuora Finance</a> features are enabled.

recognizedRevenueAccountingCodeIdstring

ID of the recognizedRevenueAccountingCode of a standalone charge.

Note: This field is available when the <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders" target="_blank">Standalone Orders</a> and <a href="https://docs.zuora.com?resourceId=ar-zuora-finance" target="_blank">Zuora Finance</a> features are enabled.

prepaidUOMstring

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

Unit of measurement for a prepayment charge.

drawdownUomstring

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

Unit of measurement for a drawdown charge.

salesPricenumber

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

Indicates whether the rate plan charge is taxable.

revertedboolean

Indicates whether the rate plan charge has been reverted.

reflectDiscountInNetAmountboolean

Indicates whether the discount is reflected in the net amount.

Changes

No operation changes recorded.