# Retrieve a subscription by key

This REST API reference describes how to retrieve detailed information
about a specified subscription in the latest version.

Endpoint: GET /v1/subscriptions/{subscription-key}
Version: 2026-02-20
Security: bearerAuth

## Header parameters:

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

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

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

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

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

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

  - `Zuora-Org-Ids` (string)
    Comma separated IDs. If you have Zuora Multi-Org enabled, 
you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

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

  - `Zuora-Version` (string)
    The minor API version.

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

## Path parameters:

  - `subscription-key` (string, required)
    Possible values are:
  * a subscription number
  * a subscription ID

## Query parameters:

  - `charge-detail` (string)
    The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.

Possible values are:

 * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates.
 * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate  ratePlanCharges >chargeSegments nested field is returned in the response. The chargeSegments field contains an array of the charge information for all the charge segments.

 * __specific-segment__: Use this value together with as-of-date={specificDate}. The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)) is returned. The format of the date is yyyy-mm-dd.

  - `as-of-date` (string)
    The date for charge-detail. It is only available when charge-detail is specific-segment.

The date should be in the format YYYY-MM-DD.

  - `exclude-rate-plans-with-no-charges` (boolean)
    When a rate plan charge has multiple segments, the last segment is returned by default. 

If this charge has been removed before the start date of the last segment (the latest one), with this parameter set to true, this charge is excluded from the response; 
If all the charges under a rate plan are excluded, the rate plan is not returned in the response.


The default value is false.

  - `getDetailedMetrics` (boolean)
    If the getDetailedMetrics field is true, contractedNetMrr, asOfDayGrossMrr, asOfDayNetMrr, and netTotalContractedValue will be in the response.
The default value is false.

  - `asOfDay` (string)
    The date for detailed metrics. Only available when getDetailedMetrics is true.
The date should be in the format YYYY-MM-DD.

The default value is the current date.

  - `getInvoiceOwnerDetails` (boolean)
    Retrieves the invoice owner of a subscription. If this parameter is set to true, the invoice owner account details invoiceOwnerAccountDetails will be in the response.

  - `getSubscriptionOwnerDetails` (boolean)
    Retrieves the owner of a subscription. If this parameter is set to true, the subscription owner account details accountOwnerDetails will be in the response.

## Response 200 fields (application/json):

  - `accountId` (string)
    The ID of the account associated with this subscription.

  - `accountName` (string)
    The name of the account associated with this subscription.

  - `accountNumber` (string)
    The number of the account associated with this subscription.

  - `autoRenew` (boolean)
    If true, the subscription automatically renews at the end of the term. Default is false.

  - `billToContact` (object)
    Container for bill-to contact information. 

Notes: 
  - If the bill-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the bill-to contact on the subscription, see Overview of Flexible Billing Attributes.
  - If the bill-to contact is not specified on the subscription, the bill-to contact on the invoice owner account will be populated in this field.

  - `billToContact.address1` (string)
    First address line, 255 characters or less.

  - `billToContact.address2` (string)
    Second address line, 255 characters or less.

  - `billToContact.asBillTo` (boolean)
    Indicates whether the contact can be specified as a bill-to contact.

This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management.

  - `billToContact.asShipTo` (boolean)
    Indicates whether the contact can be specified as a ship-to contact.

This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management.

  - `billToContact.asSoldTo` (boolean)
    Indicates whether the contact can be specified as a sold-to contact.

This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management.

  - `billToContact.city` (string)
    City, 40 characters or less.

  - `billToContact.country` (string,null)
    Full country name. This field does not contain the ISO-standard abbreviation of the country name.

  - `billToContact.county` (string,null)
    County; 32 characters or less. Zuora Tax uses this information to calculate county taxation.

  - `billToContact.fax` (string)
    Fax phone number, 40 characters or less.

  - `billToContact.firstName` (string)
    First name, 100 characters or less.

  - `billToContact.id` (string)
    Contact ID.

  - `billToContact.lastName` (string)
    Last name, 100 characters or less.

  - `billToContact.state` (string)
    Full state name. This field does not contain the ISO-standard abbreviation of the state name.

  - `billToContact.taxRegion` (string)
    A region string, defined in your Zuora tax rules.

  - `billToContact.workEmail` (string)
    Work email address, 80 characters or less.

  - `billToContact.workPhone` (string)
    Work phone number, 40 characters or less.

  - `billToContact.zipCode` (string)
    Zip code, 20 characters or less.

  - `cancelReason` (string)
    The reason for a subscription cancellation copied from the changeReason field of a Cancel Subscription order action. 

This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be null.

  - `contractEffectiveDate` (string)
    Effective contract date for this subscription, as yyyy-mm-dd.

  - `contractedMrr` (number)
    Monthly recurring revenue of the subscription.

  - `contractedNetMrr` (number)
    Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.

  - `asOfDayGrossMrr` (number)
    Monthly recurring revenue of the subscription exclusive of any discounts applicable as of specified day.

  - `asOfDayNetMrr` (number)
    Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day.

  - `netTotalContractedValue` (number)
    Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.

  - `currency` (string)
    The currency of the subscription.
Note: This field is available only if you have the Multiple Currencies feature enabled.

  - `currentTerm` (integer)
    The length of the period for the current subscription term.

  - `currentTermPeriodType` (string)
    The period type for the current subscription term.

Values are:

* Month (default)
* Year
* Day
* Week

  - `customerAcceptanceDate` (string)
    The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.

  - `externallyManagedBy` (string)
    An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.
    Enum: "Amazon", "Apple", "Google", "Roku"

  - `id` (string)
    Subscription ID.

  - `initialTerm` (integer)
    The length of the period for the first subscription term.

  - `initialTermPeriodType` (string)
    The period type for the first subscription term.

Values are:

* Month (default)
* Year
* Day
* Week

  - `invoiceGroupNumber` (string,null)
    The number of the invoice group associated with the subscription.

The value of this field is null if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.

  - `invoiceOwnerAccountId` (string)

  - `invoiceOwnerAccountName` (string)

  - `invoiceOwnerAccountNumber` (string)

  - `invoiceScheduleId` (integer)
    The ID of the invoice schedule associated with the subscription.

If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule.

Note: This field is available only if you have the Billing Schedule feature enabled.

  - `invoiceSeparately` (boolean)
    Separates a single subscription from other subscriptions and creates an invoice for the subscription. 

If the value is true, the subscription is billed separately from other subscriptions. If the value is false, the subscription is included with other subscriptions in the account invoice.

  - `invoiceTemplateId` (string,null)
    The ID of the invoice template associated with the subscription.

Note: 
  - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. 
  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Template from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.

  - `invoiceTemplateName` (string)
    The name of the invoice template associated with the subscription.

Note: 
  - If you have the Flexible Billing Attributes feature disabled, the value of this field is null in the response body. 
  - If you have the Flexible Billing Attributes feature enabled, and you do not specify the invoiceTemplateId field in the request or you select Default Template from Account for the invoiceTemplateId field during subscription creation, the value of the invoiceTemplateName field is automatically set to null in the response body.

  - `isLatestVersion` (boolean)
    If true, the current subscription object is the latest version.

  - `lastBookingDate` (string)
    The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value today is set per the user's timezone. The value of this field is as follows:
* For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date.
* For a subscription changed by an amendment, this field has the value of the amendment booking date.
* For a subscription created or changed by an order, this field has the value of the order date.

  - `notes` (string)
    A string of up to 65,535 characters.

  - `orderNumber` (string)
    The order number of the order in which the changes on the subscription are made. 

Note: This field is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). We will investigate your use cases and data before enabling this feature for you.

  - `organizationLabel` (string)
    The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

  - `originalListPrice` (number)
    The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.


Note: This field applies to the following charges in a subscription created through an order:
  - oneTimeFlatFee
  - oneTimePerUnit
  - recurringFlatFee
  - recurringPerUnit
  - usageFlatFee
  - usagePerUnit 
  - usageOverage
  - usageTieredWithOverage

  - `paymentTerm` (string)
    The name of the payment term associated with the subscription. For example, Net 30. The payment term determines the due dates of invoices.

Note: 
  - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. 
  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Term from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.

  - `ramp` (object)
    Ramp information associated with the subscription including the ramp intervals and the charges.

  - `ramp.id` (string)
    The ID of the ramp.

  - `ramp.name` (string)
    The name of the ramp.

  - `ramp.number` (string)
    The number of the ramp. It is automatically generated by the billing
system.

  - `ramp.description` (string)
    The short description of the ramp.

  - `ramp.intervals` (array)
    Container for the intervals that the ramp is split into in its timeline.

  - `ramp.intervals.description` (string)
    The short description of the interval.

  - `ramp.intervals.endDate` (string)
    The end date of the interval.

  - `ramp.intervals.name` (string)
    The name of the interval.

  - `ramp.intervals.startDate` (string)
    The start date of the interval.

  - `ramp.charges` (array)
    Container for the rate plan charges that are considered as part of the
ramp deal.

  - `ramp.charges.chargeNumber` (string)
    The number of the rate plan charge.

  - `ratePlans` (array)
    Container for rate plans.

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

  - `ratePlans.id` (string)
    Rate plan ID.

  - `ratePlans.lastChangeType` (string)
    The last amendment on the rate plan. 


Note: If a subscription is created through an order, this field is only available if multiple orders are created on the subscription.


Possible Values:
  * Add
  * Update
  * Remove

  - `ratePlans.productId` (string)

  - `ratePlans.productName` (string)

  - `ratePlans.productRatePlanId` (string)

  - `ratePlans.productSku` (string)
    The unique SKU for the product.

  - `ratePlans.contractedMrr` (number)
    Monthly recurring revenue of the subscription rate plan exclusive of all the discounts applicable.

  - `ratePlans.contractedNetMrr` (number)
    Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.

  - `ratePlans.asOfDayGrossMrr` (number)
    Monthly recurring revenue of the subscription rate plan exclusive of any discounts applicable as of specified day.

  - `ratePlans.asOfDayNetMrr` (number)
    Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day.

  - `ratePlans.ratePlanCharges` (array)
    Container for one or more charges.

  - `ratePlans.ratePlanCharges.amendedByOrderOn` (string)
    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.

  - `ratePlans.ratePlanCharges.applyDiscountTo` (string)
    Specifies the type of charges a specific discount applies to. 

This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is null.

Possible values:

* RECURRING
* USAGE
* ONETIMERECURRING
* ONETIMEUSAGE
* RECURRINGUSAGE
* ONETIMERECURRINGUSAGE

  - `ratePlans.ratePlanCharges.applyToBillingPeriodPartially` (boolean)
    Allow the discount duration to be aligned with the billing period partially.

Note: This field is only available if you have the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature enabled.

  - `ratePlans.ratePlanCharges.billingDay` (string)
    Billing cycle day (BCD), which is when bill runs generate invoices
for charges associated with the product rate plan charge or the account.  

Values:

* DefaultFromCustomer
* SpecificDayofMonth(# of the month)
* SubscriptionStartDay
* ChargeTriggerDay
* SpecificDayofWeek/dayofweek: in which dayofweek is the day in the week you define your billing periods to start.

In the response data, a day-of-the-month ordinal value (first-31st) appears in place of the hash sign above ("#"). If this value exceeds the number of days in a particular month, the last day of the month is used as the BCD.

  - `ratePlans.ratePlanCharges.billingPeriod` (string)
    Allows billing period to be overridden on the rate plan charge.

  - `ratePlans.ratePlanCharges.billingPeriodAlignment` (string)
    Possible values:

* AlignToCharge
* AlignToSubscriptionStart
* AlignToTermStart

  - `ratePlans.ratePlanCharges.billingTiming` (string)
    The billing timing for the charge. This field is only used if the ratePlanChargeType value is Recurring.

Possible values are:

* In Advance
* In Arrears

Note: 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/).

  - `ratePlans.ratePlanCharges.chargeFunction` (string)
    Note: This field is only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 141 or higher. Otherwise, an error occurs.

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.
    Enum: "Standard", "Prepayment", "CommitmentTrueUp", "Drawdown", "CreditCommitment", "DrawdownAndCreditCommitment"

  - `ratePlans.ratePlanCharges.commitmentType` (string)
    Note: This field is only available if you have the Prepaid with Drawdown 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.
    Enum: "UNIT", "CURRENCY"

  - `ratePlans.ratePlanCharges.chargeModelConfiguration` (object)
    Container for charge model configuration data.

Note: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. These charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.

  - `ratePlans.ratePlanCharges.chargeModelConfiguration.customFieldPerUnitRate` (string)
    The custom field that carries the per-unit rate for each usage record. For example, perUnitAmount__c.
    
This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.

  - `ratePlans.ratePlanCharges.chargeModelConfiguration.customFieldTotalAmount` (string)
    The custom field that carries the total amount to charge for a usage record. For example, totalAmount__c. 
    
This field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.

  - `ratePlans.ratePlanCharges.chargeModelConfiguration.formula` (string)
    The pricing formula to calculate actual rating amount for each usage record.

This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.

  - `ratePlans.ratePlanCharges.chargeSegments` (array)
    This field is returned only if you have set the charge-detail query parameter to all-segments.
Container for the charge information for all the charge segments.

  - `ratePlans.ratePlanCharges.chargeSegments.id` (string)
    ID of the charge.

  - `ratePlans.ratePlanCharges.chargeSegments.applyDiscountTo` (string,null)
    Specifies the type of charges a specific discount applies to. 

This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is null.
    Enum: "ONETIME", "RECURRING", "USAGE", "ONETIMERECURRING", "ONETIMEUSAGE", "RECURRINGUSAGE", "ONETIMERECURRINGUSAGE", null

  - `ratePlans.ratePlanCharges.chargeSegments.chargeFunction` (string)
    Note: This field is only available if you have the Unbilled Usage feature enabled.

Define what type of charge it is in Advanced consumption billing:  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.
    Enum: "Standard", "Prepayment", "CommitmentTrueUp", "Drawdown", "CreditCommitment", "DrawdownAndCreditCommitment"

  - `ratePlans.ratePlanCharges.chargeSegments.chargedThroughDate` (string)
    The date through which a customer has been billed for the charge.

  - `ratePlans.ratePlanCharges.chargeSegments.commitmentType` (string)
    Note: This field is only available if you have the Unbilled Usage
feature enabled.


The type of commitment. A prepaid charge can be UNIT or CURRENCY. And a min commitment(in-arrears) charge can only be CURRENCY type.
For topup(recurring/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.
    Enum: "UNIT", "CURRENCY"

  - `ratePlans.ratePlanCharges.chargeSegments.prepaidCommittedAmount` (string,null)
    Note: This field is only available if you have the Prepaid with Drawdown enabled.

The amount of the prepaid committed amount.

  - `ratePlans.ratePlanCharges.chargeSegments.creditOption` (string,null)
    Note: This field is only available if you have the Prepaid with Drawdown
 feature enabled. \nTo use this field, you must set the X-Zuora-WSDL-Version request header to 114 or higher. Otherwise, an error occurs.
 
 The way to calculate credit. See Credit Option for more information.
    Enum: "TimeBased", "ConsumptionBased", "FullCreditBack", null

  - `ratePlans.ratePlanCharges.chargeSegments.currency` (string)
    Currency used by the account. For example, USD or EUR.

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule` (object)
    The deliverySchedule 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://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. You can check Delivery Pricing in Billing Settings > Enable Charge Types / Models.

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule.frequency` (string)
    Specifies delivery frequency for the delivery schedule.
    Enum: "Weekly"

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule.friday` (boolean)
    Indicates whether delivery occurs on Friday.

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule.monday` (boolean)
    Indicates whether delivery occurs on Monday.

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule.saturday` (boolean)
    Indicates whether delivery occurs on Saturday.

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule.sunday` (boolean)
    Indicates whether delivery occurs on Sunday.

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule.thursday` (boolean)
    Indicates whether delivery occurs on Thursday.

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule.tuesday` (boolean)
    Indicates whether delivery occurs on Tuesday.

  - `ratePlans.ratePlanCharges.chargeSegments.deliverySchedule.wednesday` (boolean)
    Indicates whether delivery occurs on Wednesday.

  - `ratePlans.ratePlanCharges.chargeSegments.numberOfDeliveries` (number,null)
    The number of the deliveries.

  - `ratePlans.ratePlanCharges.chargeSegments.description` (string)
    Description of the rate plan charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.discountAmount` (number,null)
    The amount of the discount.

  - `ratePlans.ratePlanCharges.chargeSegments.discountApplyDetails` (array,null)
    Container for the application details about a discount rate plan charge. 

Only discount rate plan charges have values in this field.

  - `ratePlans.ratePlanCharges.chargeSegments.discountApplyDetails.appliedProductName` (string)
    The name of the product that the discount rate plan charge applies to.

  - `ratePlans.ratePlanCharges.chargeSegments.discountApplyDetails.appliedProductRatePlanChargeId` (string)
    The ID of the product rate plan charge that the discount rate plan charge applies to.

  - `ratePlans.ratePlanCharges.chargeSegments.discountApplyDetails.appliedProductRatePlanChargeName` (string)
    The name of the product rate plan charge that the discount rate plan charge applies to.

  - `ratePlans.ratePlanCharges.chargeSegments.discountApplyDetails.appliedProductRatePlanId` (string)
    The ID of the product rate plan that the discount rate plan charge applies to.

  - `ratePlans.ratePlanCharges.chargeSegments.discountApplyDetails.appliedProductRatePlanName` (string)
    The name of the product rate plan that the discount rate plan charge applies to.

  - `ratePlans.ratePlanCharges.chargeSegments.discountClass` (string,null)
    The class that the discount belongs to. The discount class defines
the order in which discount rate plan charges are applied.


For more information, see Manage Discount Classes.

  - `ratePlans.ratePlanCharges.chargeSegments.discountLevel` (string)
    The level of the discount. 
 
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.
    Enum: "rateplan", "subscription", "account"

  - `ratePlans.ratePlanCharges.chargeSegments.discountPercentage` (number,null)
    The amount of the discount as a percentage.

  - `ratePlans.ratePlanCharges.chargeSegments.applyToBillingPeriodPartially` (boolean)
    A value of true indicates that the charge segment is applied to a billing period
partially. The value of this field is false by default.

  - `ratePlans.ratePlanCharges.chargeSegments.dmrc` (number)
    The change (delta) of monthly recurring charge exists when the change
in monthly recurring revenue caused by an amendment or a new subscription.

  - `ratePlans.ratePlanCharges.chargeSegments.done` (boolean)
    A value of true indicates that an invoice for a charge segment
has been completed. A value of false indicates that an invoice has not been
completed for the charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.drawdownRate` (number)
    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).

  - `ratePlans.ratePlanCharges.chargeSegments.drawdownUom` (string)
    Specifies the units to measure usage.

  - `ratePlans.ratePlanCharges.chargeSegments.dtcv` (number)
    After an amendment or an AutomatedPriceChange event, dtcv displays the change (delta) for the total contract value (TCV) amount for this charge, compared with its previous value with recurring charge types.

  - `ratePlans.ratePlanCharges.chargeSegments.effectiveEndDate` (string)
    The effective end date of the charge.

  - `ratePlans.ratePlanCharges.chargeSegments.effectiveStartDate` (string)
    The effective start date of the charge.

  - `ratePlans.ratePlanCharges.chargeSegments.endDateCondition` (string)
    Condition for the charge to become inactive.

If the value of this field is Fixed_Period, 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 Specific_End_Date, use the specificEndDate field to specify the date when then charge becomes inactive.
    Enum: "Subscription_End", "Fixed_Period", "Specific_End_Date", "One_Time"

  - `ratePlans.ratePlanCharges.chargeSegments.includedUnits` (number)
    The number of units included in this charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.inputArgumentId` (string)
    The ID of the input argument for the charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.isCommitted` (boolean)
    Indicates if the charge segment is committed.

  - `ratePlans.ratePlanCharges.chargeSegments.isPrepaid` (boolean)
    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.

  - `ratePlans.ratePlanCharges.chargeSegments.isRollover` (boolean)
    Note: This field is only available if you have the Prepaid with Drawdown
feature enabled.


It determines whether the rollover fields are needed.

  - `ratePlans.ratePlanCharges.chargeSegments.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.

  - `ratePlans.ratePlanCharges.chargeSegments.originalOrderDate` (string)
    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.

  - `ratePlans.ratePlanCharges.chargeSegments.overagePrice` (number)
    Price for units over the allowed amount. 

Available for the usage-based charge type for the Overage and Tiered with Overage charge models.

  - `ratePlans.ratePlanCharges.chargeSegments.prepaidOperationType` (string)
    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.
    Enum: "topup", "drawdown"

  - `ratePlans.ratePlanCharges.chargeSegments.prepaidQuantity` (number)
    Note: This field is only available if you have the Prepaid with Drawdown
feature enabled.

The number of units included in a prepayment charge.

  - `ratePlans.ratePlanCharges.chargeSegments.prepaidTotalQuantity` (number)
    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.

  - `ratePlans.ratePlanCharges.chargeSegments.prepaidUOM` (string)
    Specifies the units to measure usage.

  - `ratePlans.ratePlanCharges.chargeSegments.quantity` (number)
    Number of units purchased.

  - `ratePlans.ratePlanCharges.chargeSegments.price` (number)
    The price of the charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.priceChangeOption` (string,null)
    Applies an automatic price change when a termed subscription is renewed.
    Enum: "NoChange", "SpecificPercentageValue", "UseLatestProductCatalogPricing", null

  - `ratePlans.ratePlanCharges.chargeSegments.priceIncreasePercentage` (number,null)
    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

  - `ratePlans.ratePlanCharges.chargeSegments.pricingSummary` (string)
    A concise description of the charge model and pricing that is suitable to
show to your customers.

  - `ratePlans.ratePlanCharges.chargeSegments.originalListPrice` (number,null)
    The original list price is the price of a product or service at which it
is listed for sale by a manufacturer or retailer.

  - `ratePlans.ratePlanCharges.chargeSegments.processedThroughDate` (string)
    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.

  - `ratePlans.ratePlanCharges.chargeSegments.rolloverApply` (string)
    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.
    Enum: "ApplyFirst", "ApplyLast"

  - `ratePlans.ratePlanCharges.chargeSegments.rolloverPeriodLength` (integer)
    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.

  - `ratePlans.ratePlanCharges.chargeSegments.rolloverPeriods` (integer)
    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.

  - `ratePlans.ratePlanCharges.chargeSegments.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.

  - `ratePlans.ratePlanCharges.chargeSegments.segment` (integer)
    Segment number of the charge.

  - `ratePlans.ratePlanCharges.chargeSegments.specificEndDate` (string)
    Defines when the charge ends after the charge trigger date.

This field is only applicable when the endDateCondition field is Specific_End_Date.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing` (array)

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.duration` (integer)
    Duration period of this interval.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.price` (number)
    Price of this interval.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.sequence` (integer)
    A system-generated number that indicates the sequence in which each interval price is billed.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.subscriptionChargeIntervalPriceTiers` (array)

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.subscriptionChargeIntervalPriceTiers.endingUnit` (number)
    Decimal defining end of tier range.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.subscriptionChargeIntervalPriceTiers.isOveragePrice` (boolean)
    True if the price is overage price for the tier.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.subscriptionChargeIntervalPriceTiers.price` (number)
    The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the price field directly under the productRatePlanCharges applies.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.subscriptionChargeIntervalPriceTiers.priceFormat` (string)
    Tier price format. Allowed values: flat fee, per unit.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.subscriptionChargeIntervalPriceTiers.startingUnit` (number)
    Decimal defining start of tier range.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.subscriptionChargeIntervalPriceTiers.tier` (integer)
    Unique number of the tier.

  - `ratePlans.ratePlanCharges.chargeSegments.subscriptionChargeIntervalPricing.type` (string)
    Interval type of this pricing.
    Enum: "Day", "Month", "Infinity"

  - `ratePlans.ratePlanCharges.chargeSegments.tcv` (number)
    Total contract value (TCV) is the sum of one-time charges, recurring
charges, and usage charges. The TCV calculation includes one-time
charges, recurring charges, and usage charges.

  - `ratePlans.ratePlanCharges.chargeSegments.tiers` (array,null)

  - `ratePlans.ratePlanCharges.chargeSegments.tiers.priceFormat` (string)
    Tier price format.
    Enum: "FlatFee", "PerUnit"

  - `ratePlans.ratePlanCharges.chargeSegments.tiers.originalListPrice` (number)
    The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.

  - `ratePlans.ratePlanCharges.chargeSegments.triggerDate` (string,null)
    The date when the charge becomes effective and billing begins, in yyyy-mm-dd format.

  - `ratePlans.ratePlanCharges.chargeSegments.billingPeriodAlignment` (string)
    Specifies how Zuora determines when to start new billing periods. You
can use this field to align the billing periods of different charges.


* AlignToCharge - Zuora starts a new billing period on the first billing day that
falls on or after the date when the charge becomes active.

* AlignToSubscriptionStart - Zuora starts a new billing period on the first billing
day that falls on or after the start date of the subscription.

* AlignToTermStart - For each term of the subscription, Zuora starts a new billing
period on the first billing day that falls on or after the start date of the term.


See the billCycleType field for information about how Zuora determines the billing
day.

Note: AlignToTermEnd is only available for prepayment charges by default.
To enable this value for non-prepaid recurring charges, contact Zuora Global Support.
    Enum: "AlignToCharge", "AlignToSubscriptionStart", "AlignToTermStart", "AlignToTermEnd"

  - `ratePlans.ratePlanCharges.chargeSegments.triggerEvent` (string)
    Condition for the charge to become active. If this field is not specified,
the value of the field will be defaulted to the trigger event value defined in the
product catalog.


If the value of this field is SpecificDate, use the specificTriggerDate field
to specify the date when the charge becomes active.
    Enum: "ContractEffective", "ServiceActivation", "CustomerAcceptance", "SpecificDate"

  - `ratePlans.ratePlanCharges.chargeSegments.upToPeriods` (integer,null)
    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.

The value is inherited from ProductRatePlanCharge.UpToPeriods field.

  - `ratePlans.ratePlanCharges.chargeSegments.upToPeriodsType` (string,null)
    Unit of time that the charge duration is measured in. Only applicable
if the value of the endDateCondition field is Fixed_Period.
    Enum: "Days", "Weeks", "Months", "Years", "Billing_Periods", null

  - `ratePlans.ratePlanCharges.chargeSegments.validityPeriodType` (string,null)
    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.
    Enum: "SUBSCRIPTION_TERM", "ANNUAL", "SEMI_ANNUAL", "QUARTER", "MONTH", null

  - `ratePlans.ratePlanCharges.chargeSegments.salesPrice` (number)
    The sales price of the charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.accountingCode` (string,null)
    The accounting code of the charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.revenueRecognitionCode` (string,null)
    The revenue recognition code of the charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.revRecTriggerCondition` (string,null)
    Specifies when revenue recognition begins.

  - `ratePlans.ratePlanCharges.chargeSegments.estimatedEndDate` (string)
    The estimated end date of the charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.estimatedStartDate` (string)
    The estimated start date of the charge segment.

  - `ratePlans.ratePlanCharges.chargeSegments.taxable` (boolean,null)
    Indicates whether the charge is taxable.

  - `ratePlans.ratePlanCharges.chargeSegments.taxCode` (string,null)
    The tax code of a charge.

  - `ratePlans.ratePlanCharges.chargeSegments.taxMode` (string,null)
    Determines how to define taxation for the charge.

It affects the tax calculation of the charge.
    Enum: "TaxExclusive", "TaxInclusive", null

  - `ratePlans.ratePlanCharges.creditOption` (string)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. 
To use this field, you must set the X-Zuora-WSDL-Version request header to 114 or higher. Otherwise, an error occurs. 
The way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information.
    Enum: "TimeBased", "ConsumptionBased", "FullCreditBack"

  - `ratePlans.ratePlanCharges.description` (string)
    Description of the rate plan charge.

  - `ratePlans.ratePlanCharges.discountClass` (string)
    The class that the discount belongs to. The discount class defines the order in which discount rate plan charges are applied.

For more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).

  - `ratePlans.ratePlanCharges.discountLevel` (string)
    The level of the discount. Values: RatePlan, Subscription, Account.

  - `ratePlans.ratePlanCharges.dmrc` (number)
    The change (delta) of monthly recurring charge exists when the change in monthly recurring revenue caused by an amendment or a new subscription.

  - `ratePlans.ratePlanCharges.done` (boolean)
    A value of true indicates that an invoice for a charge segment has been completed. A value of false indicates that an invoice has not been completed for the charge segment.

  - `ratePlans.ratePlanCharges.drawdownRate` (number)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).

  - `ratePlans.ratePlanCharges.drawdownUom` (string)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).

  - `ratePlans.ratePlanCharges.effectiveEndDate` (string)
    The effective end date of the rate plan charge.

  - `ratePlans.ratePlanCharges.effectiveStartDate` (string)
    The effective start date of the rate plan charge.

  - `ratePlans.ratePlanCharges.endDateCondition` (string)
    Defines when the charge ends after the charge trigger date.

If the subscription ends before the charge 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 charge end date.

Values:

* Subscription_End
* Fixed_Period
* Specific_End_Date
* One_Time

  - `ratePlans.ratePlanCharges.estimatedStartDate` (string)
    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.

  - `ratePlans.ratePlanCharges.estimatedEndDate` (string)
    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.

  - `ratePlans.ratePlanCharges.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.

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

  - `ratePlans.ratePlanCharges.excludeItemBookingFromRevenueAccounting` (boolean)
    The flag to exclude rate plan charges from revenue accounting.

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

  - `ratePlans.ratePlanCharges.id` (string)
    Rate plan charge ID.

  - `ratePlans.ratePlanCharges.includedUnits` (number)
    Specifies the number of units in the base set of units.

  - `ratePlans.ratePlanCharges.invoiceScheduleId` (string)
    The ID of the invoice schedule associated with the rate plan charge on the subscription.

Note: This field is available only if you have the Billing Schedule feature enabled.

  - `ratePlans.ratePlanCharges.isAllocationEligible` (boolean)
    This field is used to identify if the charge segment is allocation
eligible in revenue recognition.


Note: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support.

  - `ratePlans.ratePlanCharges.isDimensionalPrice` (boolean)
    Note: This field is only available when the Dynamic Pricing feature is enabled. 


Indicates whether the charge uses dimensional pricing. When set to true, this charge enables dynamic pricing.

  - `ratePlans.ratePlanCharges.isPrepaid` (boolean)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: true or false.

  - `ratePlans.ratePlanCharges.isPriceNegotiated` (boolean)
    Note: This field is only available when the Negotiated Price Table feature is enabled.


Indicates whether the charge uses negotiated pricing. When set to true, this charge defines a negotiated price table.

  - `ratePlans.ratePlanCharges.isRollover` (boolean)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

The value is either "True" or "False". It determines whether the rollover fields are needed.

  - `ratePlans.ratePlanCharges.isStackedDiscount` (boolean)
    Note: This field is only applicable to the Discount - Percentage charge model.

To use this field, you must set the X-Zuora-WSDL-Version request header to 130 or higher. Otherwise, an error occurs.

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://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).

  - `ratePlans.ratePlanCharges.isUnbilled` (boolean)
    This field is used to dictate how to perform the accounting during
revenue recognition.


Note: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support.

  - `ratePlans.ratePlanCharges.listPriceBase` (string)
    List price base; possible values are:

* Per_Billing_Period
* Per_Month
* Per_Week
* Per_Year
* Per_Specific_Months

  - `ratePlans.ratePlanCharges.model` (string)
    Charge model; possible values are:

* FlatFee
* PerUnit
* Overage
* Volume
* Tiered
* TieredWithOverage
* DiscountFixedAmount
* DiscountPercentage
* MultiAttributePricing
* PreratedPerUnit
* PreratedPricing
* HighWatermarkVolumePricing
* HighWatermarkTieredPricing
* Delivery

  - `ratePlans.ratePlanCharges.mrr` (number)
    Monthly recurring revenue of the rate plan charge.

  - `ratePlans.ratePlanCharges.name` (string)
    Charge name.

  - `ratePlans.ratePlanCharges.number` (string)
    Charge number.

  - `ratePlans.ratePlanCharges.numberOfDeliveries` (number)
    Number of deliveries in the billing period for the charge segment.

The numberOfDeliveries is used for the Delivery Pricing charge model only.

  - `ratePlans.ratePlanCharges.numberOfPeriods` (integer)
    Specifies the number of periods to use when calculating charges in an overage smoothing charge model.

  - `ratePlans.ratePlanCharges.originalChargeId` (string)
    The original ID of the rate plan charge.

  - `ratePlans.ratePlanCharges.originalOrderDate` (string)
    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 sale order line in Zuora Revenue.

  - `ratePlans.ratePlanCharges.overageCalculationOption` (string)
    Determines when to calculate overage charges.

  - `ratePlans.ratePlanCharges.overagePrice` (number)
    The price for units over the allowed amount.

  - `ratePlans.ratePlanCharges.overageUnusedUnitsCreditOption` (string)
    Determines whether to credit the customer with unused units of usage.

  - `ratePlans.ratePlanCharges.prepaidOperationType` (string)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

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

  - `ratePlans.ratePlanCharges.prepaidQuantity` (number)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).

  - `ratePlans.ratePlanCharges.prepaidTotalQuantity` (number)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/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](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).

  - `ratePlans.ratePlanCharges.prepaidUom` (string)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

Unit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).

  - `ratePlans.ratePlanCharges.price` (number)
    The price associated with the rate plan charge expressed as a decimal.

  - `ratePlans.ratePlanCharges.pricingAttributes` (object)
    Container for pricing attributes that provide additional context for dynamic pricing. This field includes all the dynamic pricing attributes and values associated with this charge, except for the pricing attributes mapped to Zuora Usage object fields.


Note: To enable Dynamic Pricing, submit a request to Zuora Global Support.

  - `ratePlans.ratePlanCharges.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.

  - `ratePlans.ratePlanCharges.priceChangeOption` (string)
    When the following is true:

1. AutomatedPriceChange setting is on

2. Charge type is not one-time

3. Charge model is not discount percentage

Then an automatic price change can have a value for when a termed subscription is renewed. 

Values (one of the following):

* NoChange (default)
* SpecificPercentageValue
* UseLatestProductCatalogPricing

  - `ratePlans.ratePlanCharges.priceIncreasePercentage` (number)
    A planned future price increase amount as a percentage.

  - `ratePlans.ratePlanCharges.pricingSummary` (string)
    Concise description of rate plan charge model.

  - `ratePlans.ratePlanCharges.processedThroughDate` (string)
    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.

  - `ratePlans.ratePlanCharges.productCategory` (string)
    This is used to maintain the product category. 

Note: This field is only available if you have the Additional Revenue Fields property enabled.

  - `ratePlans.ratePlanCharges.productClass` (string)
    This is used to maintain the product class. 

Note: This field is only available if you have the Additional Revenue Fields property enabled.

  - `ratePlans.ratePlanCharges.productFamily` (string)
    This is used to maintain the product family. 

Note: This field is only available if you have the Additional Revenue Fields property enabled.

  - `ratePlans.ratePlanCharges.productLine` (string)
    This is used to maintain the product line. 

Note: This field is only available if you have the Additional Revenue Fields property enabled.

  - `ratePlans.ratePlanCharges.productRatePlanChargeId` (string)

  - `ratePlans.ratePlanCharges.quantity` (number)
    The quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing.

  - `ratePlans.ratePlanCharges.ratingGroup` (string)
    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.

  - `ratePlans.ratePlanCharges.reflectDiscountInNetAmount` (boolean)
    When you apply percentage discounts to either of the following charges, you need to set the reflectDiscountInNetAmount field on your discount charge to true, to enable calculating and displaying the net amount of the following charges in Zuora Revenue.
* delivery pricing charge
* prepayment charge
* drawdown charge

Note the following:
* If you are an Order to Revenue customer, when you set the reflectDiscountInNetAmount field to true, you must also set both the excludeItemBookingFromRevenueAccounting and excludeItemBillingFromRevenueAccounting fields to true. 
* If you are a Billing - Revenue Integration customer, you must set the reflectDiscountInNetAmount field to false, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges.
* If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the reflectDiscountInNetAmount field to true.

  - `ratePlans.ratePlanCharges.revenueRecognitionTiming` (string)
    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.
    Enum: "Upon Billing Document Posting Date", "Upon Order Activation Date"

  - `ratePlans.ratePlanCharges.revenueAmortizationMethod` (string)
    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.
    Enum: "Immediate", "Ratable Using Start And End Dates"

  - `ratePlans.ratePlanCharges.rolloverApply` (string)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

This field defines the priority of rollover, which is either first or last.
    Enum: "ApplyFirst", "ApplyLast"

  - `ratePlans.ratePlanCharges.rolloverPeriodLength` (integer)
    Note: This field is only available if you have the [Prepaid with
Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/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.

  - `ratePlans.ratePlanCharges.rolloverPeriods` (number)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

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

  - `ratePlans.ratePlanCharges.segment` (integer)
    The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1.

  - `ratePlans.ratePlanCharges.smoothingModel` (string)
    Specifies when revenue recognition begins. When charge model is Overage or TieredWithOverage, smoothingModel will be one of the following values:

* ContractEffectiveDate
* ServiceActivationDate
* CustomerAcceptanceDate

  - `ratePlans.ratePlanCharges.specificBillingPeriod` (integer)
    Customizes the number of month or week for the charges billing period. This field is required if you set the value of the BillingPeriod field to Specific_Months or Specific_Weeks.

  - `ratePlans.ratePlanCharges.specificEndDate` (string)
    The specific date on which the charge ends. 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.

  - `ratePlans.ratePlanCharges.specificListPriceBase` (any)
    The number of months for the list price base of the charge. 

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

  - `ratePlans.ratePlanCharges.subscriptionChargeDeliverySchedule` (object)
    The deliverySchedule 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://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. You can check Delivery Pricing in Billing Settings > Enable Charge Types / Models.

  - `ratePlans.ratePlanCharges.subscriptionChargeIntervalPricing` (array)
    Interval Pricing information. This field is available if the Offers feature is enabled.

  - `ratePlans.ratePlanCharges.tcv` (number)
    The total contract value.

  - `ratePlans.ratePlanCharges.tiers` (array)
    One or many defined ranges with distinct pricing.

  - `ratePlans.ratePlanCharges.tiers.originalListPrice` (number)
    The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.


Note: This field applies to the following charges in a subscription created through an order:
  - oneTimeTiered
  - oneTimeVolume
  - recurringTiered
  - recurringVolume
  - usageTiered
  - usageVolume
  - usageTieredWithOverage

  - `ratePlans.ratePlanCharges.triggerDate` (string)
    The date that the rate plan charge will be triggered.

  - `ratePlans.ratePlanCharges.triggerEvent` (string)
    The event that will cause the rate plan charge to be triggered.

Possible values: 

* ContractEffective
* ServiceActivation
* CustomerAcceptance
* SpecificDate

  - `ratePlans.ratePlanCharges.type` (string)
    Charge type. Possible values are: OneTime, Recurring, Usage.

  - `ratePlans.ratePlanCharges.unusedUnitsCreditRates` (number)
    Specifies the rate to credit a customer for unused units of usage. This field is applicable only for overage charge models when the 
OverageUnusedUnitsCreditOption field value is CreditBySpecificRate.

  - `ratePlans.ratePlanCharges.upsellOriginChargeNumber` (string)
    The identifier of the original upselling charge associated with the current charge.

For a termed subscription, you can now use the "Create an order" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:
* Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell.

* In the preceding charge to add, use the upsellOriginChargeNumber field to specify the existing rate plan charge for which you want to make the quantity upsell.

Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription.   

Note: The Quantity Upsell feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global
Support](https://support.zuora.com).

  - `ratePlans.ratePlanCharges.uom` (string)
    Specifies the units to measure usage.

  - `ratePlans.ratePlanCharges.upToPeriods` (string)
    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.

  - `ratePlans.ratePlanCharges.upToPeriodsType` (string)
    The period type used to define when the charge ends. 

Values:

* Billing_Periods
* Days
* Weeks
* Months
* Years

  - `ratePlans.ratePlanCharges.usageRecordRatingOption` (string)
    Determines how Zuora processes usage records for per-unit usage charges.

  - `ratePlans.ratePlanCharges.validityPeriodType` (string)
    Note: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.

The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
    Enum: "SUBSCRIPTION_TERM", "ANNUAL", "SEMI_ANNUAL", "QUARTER", "MONTH"

  - `ratePlans.ratePlanCharges.version` (integer)
    Rate plan charge revision number.

  - `ratePlans.ratePlanName` (string)
    Name of the rate plan.

  - `ratePlans.subscriptionProductFeatures` (array)
    Container for one or more features. 

Only available when the following settings are enabled:

* The Entitlements feature in your tenant.

* The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings

  - `ratePlans.subscriptionProductFeatures.description` (string)
    Feature description.

  - `ratePlans.subscriptionProductFeatures.featureCode` (string)
    Feature code, up to 255 characters long.

  - `ratePlans.subscriptionProductFeatures.id` (string)
    SubscriptionProductFeature ID.

  - `ratePlans.subscriptionProductFeatures.name` (string)
    Feature name, up to 255 characters long.

  - `renewalSetting` (string)
    Specifies whether a termed subscription will remain TERMED or change to EVERGREEN when it is renewed. 

Values are:

* RENEW_WITH_SPECIFIC_TERM (default)
* RENEW_TO_EVERGREEN

  - `renewalTerm` (integer)
    The length of the period for the subscription renewal term.

  - `renewalTermPeriodType` (string)
    The period type for the subscription renewal term.

Values are:

* Month (default)
* Year
* Day
* Week

  - `revision` (string)
    An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions.

  - `sequenceSetId` (string,null)
    The ID of the sequence set associated with the subscription.

Note: 
  - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. 
  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Set from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.

  - `communicationProfileId` (string,null)
    The ID of the communication profile associated with the subscription.

Note: This field is available in the request body only if you have the Flexible Billing Attributes
feature turned on. The value is null in the response body without this feature turned on.

  - `sequenceSetName` (string)
    The name of the sequence set associated with the subscription.

Note: 
  - If you have the Flexible Billing Attributes feature disabled, the value of this field is null in the response body. 
  - If you have the Flexible Billing Attributes feature enabled, and you do not specify the sequenceSetId field in the request or you select Default Template from Account for the sequenceSetId field during subscription creation, the value of the sequenceSetName field is automatically set to null in the response body.

  - `serviceActivationDate` (string)
    The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd

  - `shipToContact` (object)
    Container for ship-to contact information.

Notes: 
  - If the ship-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the ship-to contact on the subscription, see Overview of Flexible Billing Attributes.
  - If the ship-to contact is not specified on the subscription, the ship-to contact on the subscription owner account will be populated in this field.

  - `soldToContact` (object)
    Container for sold-to contact information. 

Notes: 
  - If the sold-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the sold-to contact on the subscription, see Overview of Flexible Billing Attributes.
  - If the sold-to contact is not specified on the subscription, the sold-to contact on the subscription owner account will be populated in this field.

  - `status` (string)
    Subscription status; possible values are:

* Draft
* Pending Activation
* Pending Acceptance
* Active
* Cancelled
* Suspended

  - `statusHistory` (array)
    Container for status history.

  - `statusHistory.endDate` (string)
    The effective end date of the status history.

  - `statusHistory.startDate` (string)
    The effective start date of the status history.

  - `statusHistory.status` (string)
    The status of the subscription.

Values are:

* Pending Activation
* Pending Acceptance
* Active
* Cancelled
* Suspended
* OutOfTerm

  - `subscriptionEndDate` (string)
    The date when the subscription term ends, where the subscription ends at midnight the day before.
For example, if the subscriptionEndDate is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.
This date is the same as the term end date or the cancelation date, as appropriate.

  - `subscriptionNumber` (string)
    Subscription number.

  - `subscriptionStartDate` (string)
    Date the subscription becomes effective.

  - `success` (boolean)
    Returns true if the request was processed successfully.

  - `termEndDate` (string)
    Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set).

  - `termStartDate` (string)
    Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date.

  - `termType` (string)
    Possible values are: TERMED, EVERGREEN.

  - `scheduledCancelDate` (string)
    The date when the subscription is scheduled to be canceled.

  - `scheduledSuspendDate` (string)
    The date when the subscription is scheduled to be suspended.

  - `scheduledResumeDate` (string)
    The date when the subscription is scheduled to be resumed.

  - `totalContractedValue` (number)
    Total contracted value of the subscription.

  - `version` (integer)
    This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment.

  - `accountOwnerDetails` (object)
    Container for basic information about the account. 

Notes:
- In the "Retrieve an order" operation, if the getAccountDetails query parameter is set to true, the subscription owner account details subscriptionOwnerAccountDetails and invoice owner account details existingAccountDetails will be in the response. 
- In the "Retrieve a subscription by key" operation, the returned result differs based on the following query parameters: 
  - If the getSubscriptionOwnerDetails query parameter is set to true, the subscription owner account details accountOwnerDetails will be in the response.
  - If the getInvoiceOwnerDetails query parameter is set to true, the invoice owner account details invoiceOwnerAccountDetails will be in the response.
  - If both query parameters are set to true, the subscription owner account details accountOwnerDetails and invoice owner account details invoiceOwnerAccountDetails will be in the response.

  - `accountOwnerDetails.accountNumber` (string)
    Account number.

  - `accountOwnerDetails.batch` (string)
    The alias name given to a batch. A string of 50 characters or less.

  - `accountOwnerDetails.communicationProfileId` (string)
    The ID of the communication profile that this account is linked to.

  - `accountOwnerDetails.creditMemoTemplateId` (string)
    Note: This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

The unique ID of the credit memo template, configured in Billing Settings > Manage Billing Document Configuration through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.

  - `accountOwnerDetails.crmId` (string)
    CRM account ID for the account, up to 100 characters.

  - `accountOwnerDetails.customerServiceRepName` (string)
    Name of the account's customer service representative, if applicable.

  - `accountOwnerDetails.debitMemoTemplateId` (string)
    Note: This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

The unique ID of the debit memo template, configured in Billing Settings > Manage Billing Document Configuration through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.

  - `accountOwnerDetails.id` (string)
    Account ID.

  - `accountOwnerDetails.invoiceTemplateId` (string,null)
    Invoice template ID, configured in Billing Settings in the Zuora UI.

  - `accountOwnerDetails.lastMetricsUpdate` (string)
    The date and time when account metrics are last updated, if the account is a partner account.

Note: 
  - This field is available only if you have the Reseller Account feature enabled.
  - If you have the Reseller Account feature enabled, and set the partnerAccount field to false for an account, the value of the lastMetricsUpdate field is automatically set to null in the response. 
  - If you ever set the partnerAccount field to true for an account, the value of lastMetricsUpdate field is the time when the account metrics are last updated.

  - `accountOwnerDetails.name` (string)
    Account name.

  - `accountOwnerDetails.notes` (string)
    Notes associated with the account, up to 65,535 characters.

  - `accountOwnerDetails.parentId` (string)
    Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled.

  - `accountOwnerDetails.partnerAccount` (boolean)
    Whether the customer account is a partner, distributor, or reseller. 


Note: This field is available only if you have the Reseller Account feature enabled.

  - `accountOwnerDetails.profileNumber` (string)
    The number of the communication profile that this account is linked to.

  - `accountOwnerDetails.purchaseOrderNumber` (string)
    The purchase order number provided by your customer for services, products, or both purchased.

  - `accountOwnerDetails.salesRep` (string)
    The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.

  - `accountOwnerDetails.sequenceSetId` (string,null)
    The ID of the billing document sequence set that is assigned to the customer account.

  - `accountOwnerDetails.summaryStatementTemplateId` (string,null)
    The summary statement template ID. When a user attempts to generate a summary statement from the "Account Summary Statement" screen, the system utilizes this template to produce the PDF.

  - `accountOwnerDetails.status` (string)
    Account status; possible values are: Active, Draft, Canceled.

  - `accountOwnerDetails.tags` (string)

  - `accountOwnerDetails.Class__NS` (string)
    Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `accountOwnerDetails.CustomerType__NS` (string)
    Value of the Customer Type field for the corresponding customer account in NetSuite. The Customer Type field is used when the customer account is created in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
    Enum: "Company", "Individual"

  - `accountOwnerDetails.Department__NS` (string)
    Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `accountOwnerDetails.IntegrationId__NS` (string)
    ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `accountOwnerDetails.IntegrationStatus__NS` (string)
    Status of the account's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `accountOwnerDetails.Location__NS` (string)
    Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `accountOwnerDetails.Subsidiary__NS` (string)
    Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `accountOwnerDetails.SyncDate__NS` (string)
    Date when the account was sychronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `accountOwnerDetails.SynctoNetSuite__NS` (string)
    Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
    Enum: "Yes", "No"

  - `invoiceOwnerAccountDetails` (object)
    Container for basic information about the account. 

Notes:
- In the "Retrieve an order" operation, if the getAccountDetails query parameter is set to true, the subscription owner account details subscriptionOwnerAccountDetails and invoice owner account details existingAccountDetails will be in the response. 
- In the "Retrieve a subscription by key" operation, the returned result differs based on the following query parameters: 
  - If the getSubscriptionOwnerDetails query parameter is set to true, the subscription owner account details accountOwnerDetails will be in the response.
  - If the getInvoiceOwnerDetails query parameter is set to true, the invoice owner account details invoiceOwnerAccountDetails will be in the response.
  - If both query parameters are set to true, the subscription owner account details accountOwnerDetails and invoice owner account details invoiceOwnerAccountDetails will be in the response.

  - `CpqBundleJsonId__QT` (string)
    The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.

  - `OpportunityCloseDate__QT` (string)
    The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.

  - `OpportunityName__QT` (string)
    The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.

  - `QuoteBusinessType__QT` (string)
    The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.

  - `QuoteNumber__QT` (string)
    The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.

  - `QuoteType__QT` (string)
    The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.

  - `IntegrationStatus__NS` (string)
    Status of the subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `Project__NS` (string)
    The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `SalesOrder__NS` (string)
    The NetSuite sales order than the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `SyncDate__NS` (string)
    Date when the subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

## Response 500 fields (application/json):

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

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

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

## Response 4XX fields (application/json):

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

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

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

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

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

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