PUT /v1/subscriptions/{subscription-key}

Subscription number or ID. ID can be the latest version or any history version of ID.

• To make sure you update the last version of the subscription, use one of the following operations to retrieve the last version of ID:
  • List subscriptions by account key
  • Retrieve a subscription by key by using the subscription number as the subscription-key
• If you want to use any history version of ID, the STABLE_ID_PUBLIC_API permission must be enabled. Submit a request at Zuora Global Support to enable the permission. To retrieve a history version of ID, use the Retrieve a subscription by key and version operation.

Default value: "application/json"

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.

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 (').

The minor version of the Zuora REST API.

You need to set this parameter if you use the following fields:

• collect
• invoice
• includeExistingDraftDocItems
• previewType
• runBilling
• targetDate
• taxationItems

If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned.

See Zuora REST API Versions for more information.

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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 do not need to set this header.

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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

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.

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

The booking date that you want to set for the contract when you change the termType field of the subscription and as a result get a new version of subscription created. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the yyyy-mm-dd format. The default value is the current date when you make the API call.

The period type for the subscription renewal term.

This field is used with the renewalTerm field to specify the subscription renewal term.

Values are:

• Month (default)
• Year
• Day
• Week

Separates a single subscription from other subscriptions and invoices the charge independently.

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.

The default value is false. Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes.

Specifies whether to include draft invoice items in subscription previews. Values are:

• true (default). Includes draft invoice items in the preview result.
• false. Excludes draft invoice items in the preview result.

Note: This field is in Zuora REST API version control. Supported minor versions are 207.0 or later available versions. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.

If the value is true, the automatic payment is collected. If the value is false, no action is taken.

Prerequisite: The invoice or runBilling field must be true.

Note: This field is only available if you set the zuora-version request header to 196.0 or later available versions.

Default value: false

Date the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.

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.

The NetSuite sales order than the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite.

Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the invoice and credit memo generation rule.

The billing documents generated in this operation is only for this subscription, not for the entire customer account.

Possible values:

• true: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.

• false: No invoice is created.

Note: This field is in Zuora REST API version control. Supported minor versions are 211.0 or later available versions. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

Possible values:

• true
• false

Default value: false

The length of the period for the subscription renewal term. Default is 0.

Date when the subscription was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

If true, this subscription automatically renews at the end of the subscription term. Default is false.

A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.

The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.

Container for adding one or more rate plans.

The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the yyyy-mm-dd format. The default value is the current date when you make the API call.

The date when the customer accepts the contract in yyyy-mm-dd format.

If this field is not set:

• If the serviceActivationDate field is not set, the value of this field is set to be the contract effective date.
• If the serviceActivationDate field is set, the value of this field is set to be the service activation date.

The billing trigger dates must follow this rule:

contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate

An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the externalCatalogPlanId field must match one of the values that are predefined in the externallyManagedPlanIds field on a product rate plan.

Note: If both externalCatalogPlanId and productRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

The ID of the external source system. You can use this field and externalCatalogPlanId to specify a product rate plan that is imported from an external system.

Note: If both externalCatalogPlanId, externalIdSourceSystem and productRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

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.

This optional container is used to override the quantity of one or more product rate plan charges for this subscription.

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 for pricing information.

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 for pricing information.

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 for pricing information.

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 for pricing information.

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.

Description of the charge.

The period type used to define when the charge ends.

Values:

• Billing_Periods
• Days
• Weeks
• Months
• Years

You must use this field together with the upToPeriods field to specify the time period.

This field is applicable only when the endDateCondition field is set to Fixed_Period.

Specifies the type of charges that you want a specific discount to apply to.

Values:

• ONETIME
• RECURRING
• USAGE
• ONETIMERECURRING
• ONETIMEUSAGE
• RECURRINGUSAGE
• ONETIMERECURRINGUSAGE

Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models:

• Recurring

Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed.

Values: 1-31

Available for the following charge types:

• Recurring
• Usage-based

This field is used to identify if the charge segment is allocation eligible in revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

Determines whether to credit the customer with unused units of usage.

Values:

• NoCredit
• CreditBySpecificRate

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

Specifies when to start billing the customer for the charge.

Values:

• UCE
• USA
• UCA
• USD

Aligns charges within the same subscription if multiple charges begin on different dates.

Values:

• AlignToCharge
• AlignToSubscriptionStart
• AlignToTermStart

Available for the following charge types:

• Recurring
• Usage-based

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 Billing - Revenue Integration feature enabled.

Default value: false

Defines when the charge ends after the charge trigger date.

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

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.

Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types:

• One-time
• Recurring
• Usage-based

Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.

Unique number that identifies the tier that the price applies to.

Starting number of a range of units for the tier.

Indicates if pricing is a flat fee or is per unit.

Values:

• FlatFee
• PerUnit

End number of a range of units for the tier.

Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the PriceChangeOption field to SpecificPercentageValue.

Decimal between -100 and 100.

Available for the following charge types:

• Recurring
• Usage-based

Not available for the Fixed-Amount Discount charge model.

Billing timing for the charge for recurring charge types. Not avaliable for one time, usage and discount charges.

Values:

• IN_ADVANCE (default)
• IN_ARREARS

Applies an automatic price change when a termed subscription is renewed. The Zuora Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed? must be set to Yes to use this field. See Define Default Subscription Settings for more information on setting this option.

Values:

• NoChange (default)
• SpecificPercentageValue
• UseLatestProductCatalogPricing

Available for the following charge types:

• Recurring
• Usage-based
• Not available for the Fixed-Amount Discount charge model.

Specifies when to start billing the customer for the charge. Required if the triggerEvent field is set to USD.

The date when the rate plan charge is amended through an order or amendment. This field is not updatable.

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.

Specifies the percentage of a percentage discount.

Available for the following charge type for the Discount-Percentage charge model:

• Recurring

Price for units over the allowed amount.

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

Specifies the amount of fixed-amount discount.

Available for the following charge type for the Discount-Fixed Amount charge model:

• Recurring

Specifies the number of units in the base set of units for this charge. Must be >=0.

Available for the following charge type for the Overage charge model:

• Usage-based

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

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

The date when the rate plan charge is created through an order or amendment. This field is not updatable.

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.

Price for units in the subscription rate plan.

Supports all charge types for the Flat Fee and Per Unit charge models

Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the OverageUnusedUnitsCreditOption field is set to CreditBySpecificRate.

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

Unique number that identifies the charge. System-generated if not provided.

Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the billing period set as SubscriptionTerm， a new charge segment is generated for the new term.

Values:

• Month
• Quarter
• Semi_Annual
• Annual
• Eighteen_Months
• Two_Years
• Three_Years
• Five_Years
• Specific_Months
• Subscription_Term
• Week
• Specific_Weeks

Available for the following charge types:

• Recurring
• Usage-based

Number of units. Must be >=0.

Available for the following charge types for the Per Unit, Volume Pricing, and Tiered Pricing charge models:

• One-time
• Recurring

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

The list price base for the product rate plan charge.

Values:

• Per_Billing_Period
• Per_Month
• Per_Week
• Per_Year
• Per_Specific_Months

Available for the following charge type for the Flat Fee, Per Unit, Volume Pricing, and Tiered Pricing charge models:

• Recurring

The flag to exclude rate plan charges from revenue accounting.

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

Default value: false

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.

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.

The period type used to define when the charge ends.

Values:

• Billing_Periods
• Days
• Weeks
• Months
• Years

You must use this field together with the upToPeriods field to specify the time period.

This field is applicable only when the endDateCondition field is set to Fixed_Period.

Specifies how to determine the billing day for the charge. When this field is set to SpecificDayofMonth, set the BillCycleDay field. When this field is set to SpecificDayofWeek, set the weeklyBillCycleDay field.

Values:

• DefaultFromCustomer
• SpecificDayofMonth
• SubscriptionStartDay
• ChargeTriggerDay
• SpecificDayofWeek

Available for the following charge types:

• Recurring
• Usage-based

Specifies the number of month or week for the charges billing period. Required if you set the value of the billingPeriod field to Specific_Months or Specific_Weeks.

Available for the following charge types:

• Recurring
• Usage-based

Number of a product rate-plan charge for this subscription.

Specifies if the discount applies to the product rate plan only , the entire subscription, or to any activity in the account.

Values:

• rateplan
• subscription
• account

Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models:

• Recurring

This field is used to dictate how to perform the accounting during revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

The date when the amendment changes take effect. The format of the date is yyyy-mm-dd.

If there is already a future-dated Update Product amendment on the subscription, the specificUpdateDate field will be used instead of this field to specify when the Update Product amendment takes effect.

The date when the new product in the subscription is activated in yyyy-mm-dd format.

You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the serviceActivationDate field defaults to be the Contract Effective Date.

The billing trigger dates must follow this rule:

contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate

ID of a product rate plan for this subscription

Number of a product rate plan for this subscription

The type of preview you will receive.

This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.

• If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:

  • 186.0
  • 187.0
  • 188.0
  • 189.0
  • 196.0
  • 206.0

  The following values are supported in the previewType field:

  • InvoiceItem
  • ChargeMetrics
  • InvoiceItemChargeMetrics

  The default value is InvoiceItem.

• If you specify the REST API minor version to 207.0 or later available versions in the request header, the following values are supported in the previewType field:

  • LegalDoc
  • ChargeMetrics
  • LegalDocChargeMetrics

  The default value is LegalDoc.

.

Status of the subscription's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Specifies whether to include draft invoice items in subscription previews. Values are:

• true (default). Includes draft invoice items in the preview result.
• false. Excludes draft invoice items in the preview result.

Note: This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. .

Whether to automatically apply credit memos or unapplied payments, or both to an invoice.

If the value is true, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is false, no action is taken.

Note: This field is only available if you have 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 for more information.

The length of the period for the current subscription term. If termType is TERMED, this field is required and must be greater than 0. If termType is EVERGREEN, this value is ignored.

Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.

Note: The credit memo is only available if you have the Invoice Settlement feature enabled.

This field is in Zuora REST API version control. Supported minor versions are 211.0 and later. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

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.

Use this field to change one or more rate plans - to replace the existing rate plans in a subscription with other rate plans.

Note: Changing rate plans is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing.

The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the yyyy-mm-dd format. The default value is the current date when you make the API call.

The ID of the external source system. You can use this field and newExternalCatalogPlanId to specify a product rate plan that is imported from an external system.

Note: If both newExternalCatalogPlanId, newExternalIdSourceSystem and newProductRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

ID of a product rate plan for this subscription.

Number of a product rate plan for this subscription.

Effective date of the new subscription, as yyyy-mm-dd.

Use this field to choose the sub type for your change plan amendment.

However, if you do not set this field, the field will be automatically generated by the system according to the following rules:

When the old and new rate plans are within the same Grading catalog group:

• If the grade of new plan is greater than that of the old plan, this is an "Upgrade".
• If the grade of new plan is less than that of the old plan, this is a "Downgrade".
• If the grade of new plan equals that of the old plan, this is a "Crossgrade".

When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is "PlanChanged".

Possible values:

• "Downgrade"
• "Upgrade"
• "PlanChanged"
• "Crossgrade"

The date when the customer accepts the contract in yyyy-mm-dd format. When this field is not set:

• If the serviceActivationDate field is not set, the value of this field is set to be the contract effective date.
• If the serviceActivationDate field is set, the value of this field is set to be the service activation date.

The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate

An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the externalCatalogPlanId field must match one of the values that are predefined in the externallyManagedPlanIds field on a product rate plan. However, if there are multiple rate plans with the same productRatePlanId value existing in the subscription, you must use the ratePlanId field to remove the rate plan. The externalCatalogPlanId field cannot be used to distinguish multiple rate plans in this case.

Note: Provide only one of externalCatalogPlanId, ratePlanId or productRatePlanId. If more than one field is provided then the request would fail.

The ID of the external source system. You can use this field and externalCatalogPlanId to specify a product rate plan that is imported from an external system.

Note: If both externalCatalogPlanId, externalIdSourceSystem and productRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD.

Default value: false

The default value for the effectivePolicy field is as follows:

• If the rate plan change (from old to new) is an upgrade, the effective policy is EffectiveImmediately by default.
• If the rate plan change (from old to new) is a downgrade, the effective policy is EffectiveEndOfBillingPeriod by default.
• Otherwise, the effective policy is SpecificDate by default.

Notes:

• When setting this field to EffectiveEndOfBillingPeriod, you cannot set the billing trigger dates for the subscription as the system will automatically set the trigger dates to the end of billing period.
• When setting this field to SpecificDate, you must also set the contractEffectiveDate field.

Possible values:

• "EffectiveEndOfBillingPeriod"
• "SpecificDate"
• "EffectiveImmediately"

This optional container is used to override one or more product rate plan charges for this subscription.

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 for pricing information.

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 for pricing information.

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 for pricing information.

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 for pricing information.

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.

Description of the charge.

The period type used to define when the charge ends.

Values:

• Billing_Periods
• Days
• Weeks
• Months
• Years

You must use this field together with the upToPeriods field to specify the time period.

This field is applicable only when the endDateCondition field is set to Fixed_Period.

Specifies the type of charges that you want a specific discount to apply to.

Values:

• ONETIME
• RECURRING
• USAGE
• ONETIMERECURRING
• ONETIMEUSAGE
• RECURRINGUSAGE
• ONETIMERECURRINGUSAGE

Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models:

• Recurring

Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed.

Values: 1-31

Available for the following charge types:

• Recurring
• Usage-based

This field is used to identify if the charge segment is allocation eligible in revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

Determines whether to credit the customer with unused units of usage.

Values:

• NoCredit
• CreditBySpecificRate

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

Specifies when to start billing the customer for the charge.

Values:

• UCE
• USA
• UCA
• USD

Aligns charges within the same subscription if multiple charges begin on different dates.

Values:

• AlignToCharge
• AlignToSubscriptionStart
• AlignToTermStart

Available for the following charge types:

• Recurring
• Usage-based

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 Billing - Revenue Integration feature enabled.

Default value: false

Defines when the charge ends after the charge trigger date.

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

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.

Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types:

• One-time
• Recurring
• Usage-based

Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.

Unique number that identifies the tier that the price applies to.

Starting number of a range of units for the tier.

Indicates if pricing is a flat fee or is per unit.

Values:

• FlatFee
• PerUnit

End number of a range of units for the tier.

Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the PriceChangeOption field to SpecificPercentageValue.

Decimal between -100 and 100.

Available for the following charge types:

• Recurring
• Usage-based

Not available for the Fixed-Amount Discount charge model.

Billing timing for the charge for recurring charge types. Not avaliable for one time, usage and discount charges.

Values:

• IN_ADVANCE (default)
• IN_ARREARS

Applies an automatic price change when a termed subscription is renewed. The Zuora Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed? must be set to Yes to use this field. See Define Default Subscription Settings for more information on setting this option.

Values:

• NoChange (default)
• SpecificPercentageValue
• UseLatestProductCatalogPricing

Available for the following charge types:

• Recurring
• Usage-based
• Not available for the Fixed-Amount Discount charge model.

Specifies when to start billing the customer for the charge. Required if the triggerEvent field is set to USD.

The date when the rate plan charge is amended through an order or amendment. This field is not updatable.

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.

Specifies the percentage of a percentage discount.

Available for the following charge type for the Discount-Percentage charge model:

• Recurring

Price for units over the allowed amount.

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

Specifies the amount of fixed-amount discount.

Available for the following charge type for the Discount-Fixed Amount charge model:

• Recurring

Specifies the number of units in the base set of units for this charge. Must be >=0.

Available for the following charge type for the Overage charge model:

• Usage-based

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

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

The date when the rate plan charge is created through an order or amendment. This field is not updatable.

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.

Price for units in the subscription rate plan.

Supports all charge types for the Flat Fee and Per Unit charge models

Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the OverageUnusedUnitsCreditOption field is set to CreditBySpecificRate.

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

Unique number that identifies the charge. System-generated if not provided.

Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the billing period set as SubscriptionTerm， a new charge segment is generated for the new term.

Values:

• Month
• Quarter
• Semi_Annual
• Annual
• Eighteen_Months
• Two_Years
• Three_Years
• Five_Years
• Specific_Months
• Subscription_Term
• Week
• Specific_Weeks

Available for the following charge types:

• Recurring
• Usage-based

Number of units. Must be >=0.

Available for the following charge types for the Per Unit, Volume Pricing, and Tiered Pricing charge models:

• One-time
• Recurring

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

The list price base for the product rate plan charge.

Values:

• Per_Billing_Period
• Per_Month
• Per_Week
• Per_Year
• Per_Specific_Months

Available for the following charge type for the Flat Fee, Per Unit, Volume Pricing, and Tiered Pricing charge models:

• Recurring

The flag to exclude rate plan charges from revenue accounting.

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

Default value: false

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.

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.

The period type used to define when the charge ends.

Values:

• Billing_Periods
• Days
• Weeks
• Months
• Years

You must use this field together with the upToPeriods field to specify the time period.

This field is applicable only when the endDateCondition field is set to Fixed_Period.

Specifies how to determine the billing day for the charge. When this field is set to SpecificDayofMonth, set the BillCycleDay field. When this field is set to SpecificDayofWeek, set the weeklyBillCycleDay field.

Values:

• DefaultFromCustomer
• SpecificDayofMonth
• SubscriptionStartDay
• ChargeTriggerDay
• SpecificDayofWeek

Available for the following charge types:

• Recurring
• Usage-based

Specifies the number of month or week for the charges billing period. Required if you set the value of the billingPeriod field to Specific_Months or Specific_Weeks.

Available for the following charge types:

• Recurring
• Usage-based

Number of a product rate-plan charge for this subscription.

Specifies if the discount applies to the product rate plan only , the entire subscription, or to any activity in the account.

Values:

• rateplan
• subscription
• account

Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models:

• Recurring

This field is used to dictate how to perform the accounting during revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

ID of a rate plan to remove. Note that the removal of a rate plan through the Change Plan amendment supports the function of removal before future-dated removals, as in a Remove Product amendment.

An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the externalCatalogPlanId field must match one of the values that are predefined in the externallyManagedPlanIds field on a product rate plan.

Note: Provide only one of newExternalCatalogPlanId or newProductRatePlanId. If both fields are provided then the request would fail.

The date when the change in the subscription is activated in yyyy-mm-dd format. You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the serviceActivationDate field defaults to be the Contract Effective Date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate

Number of a rate plan for this subscription.

ID of the product rate plan that the removed rate plan is based on.

Number of a product rate plan for this subscription.

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.

Whether to automatically apply a credit balance to an invoice.

If the value is true, the credit balance is applied to the invoice. If the value is false, no action is taken.

To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.

Prerequisite: invoice must be true.

Note:

• If you are using the field invoiceCollect rather than the field invoice, the invoiceCollect value must be true.
• This field is deprecated if you have the Invoice Settlement feature enabled.

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.

Possible values:

• "Amazon"
• "Roku"
• "Apple"
• "Google"

Container for removing one or more rate plans.

The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the yyyy-mm-dd format. The default value is the current date when you make the API call.

The date when the customer accepts the contract in yyyy-mm-dd format.

If this field is not set:

• If the serviceActivationDate field is not set, the value of this field is set to be the contract effective date.
• If the serviceActivationDate field is set, the value of this field is set to be the service activation date.

The billing trigger dates must follow this rule:

contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate

An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the externalCatalogPlanId field must match one of the values that are predefined in the externallyManagedPlanIds field on a product rate plan. However, if there are multiple rate plans with the same productRatePlanId value existing in the subscription, you must use the ratePlanId field to remove the rate plan. The externalCatalogPlanId field cannot be used to distinguish multiple rate plans in this case.

Note: If both externalCatalogPlanId and ratePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

The ID of the external source system. You can use this field and externalCatalogPlanId to specify a product rate plan that is imported from an external system.

Note: If both externalCatalogPlanId, externalIdSourceSystem and productRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

Effective date of the new subscription, as yyyy-mm-dd.

ID of a rate plan for this subscription. This can be the latest version or any history version of ID.

The date when the remove amendment is activated in yyyy-mm-dd format.

You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the serviceActivationDate field defaults to be the Contract Effective Date.

The billing trigger dates must follow this rule:

contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate

Number of a rate plan for this subscription.

Number of a product rate plan for this subscription.

Note: This field has been replaced by the runBilling field. The invoice field is only available for backward compatibility.

Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account.

If the value is true, an invoice is created. If the value is false, no action is taken. The default value is false.

This field is in Zuora REST API version control. Supported minor versions are 196.0 and 207.0. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

String of up to 500 characters.

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.

The period type for the current subscription term.

This field is used with the CurrentTerm field to specify the current subscription term.

Values are:

• Month (default)
• Year
• Day
• Week

If true the update is made in preview mode. The default setting is false.

Possible values are: TERMED, EVERGREEN.

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.

The date of the billing document, in yyyy-mm-dd format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.

• If this field is specified, the specified date is used as the billing document date.
• If this field is not specified, the date specified in the targetDate is used as the billing document date.

The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: CreditMemo, UnappliedPayment.

Note:

• This field is valid only if the applyCredit field is set to true.
• If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
• If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is ["CreditMemo"], only credit memos are used to apply to invoices.

The NetSuite project that the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite.

Note: This field has been replaced by the targetDate field. The invoiceTargetDate field is only available for backward compatibility.

Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.

This field is in Zuora REST API version control. Supported minor versions are 207.0 and earlier available versions.

Container for updating one or more rate plans.

The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the yyyy-mm-dd format. The default value is the current date when you make the API call.

The date when the customer accepts the contract in yyyy-mm-dd format.

If this field is not set:

• If the serviceActivationDate field is not set, the value of this field is set to be the contract effective date.
• If the serviceActivationDate field is set, the value of this field is set to be the service activation date.

The billing trigger dates must follow this rule:

contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate

An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the externalCatalogPlanId field must match one of the values that are predefined in the externallyManagedPlanIds field on a product rate plan. However, if there are multiple rate plans with the same productRatePlanId value existing in the subscription, you must use the ratePlanId field to update the rate plan. The externalCatalogPlanId field cannot be used to distinguish multiple rate plans in this case.

Note: If both externalCatalogPlanId and ratePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

The ID of the external source system. You can use this field and externalCatalogPlanId to specify a product rate plan that is imported from an external system.

Note: If both externalCatalogPlanId, externalIdSourceSystem and productRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

Container for one or more product rate plan charges.

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 for pricing information.

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 for pricing information.

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 for pricing information.

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 for pricing information.

Price for units in the subscription rate plan.

Supports all charge types for the Flat Fee and Per Unit charge models

Description of the charge.

Quantity of units; must be greater than zero.

Specifies when to start billing the customer for the charge.

Values:

• UCE
• USA
• UCA
• USD

This is the date when charge changes in the REST request become effective.

triggerEvent cannot be updated for the following using the REST update subscription call:

• One-time charge type
• Discount-Fixed Amount charge model
• Discount-Percentage charge model

Aligns charges within the same subscription if multiple charges begin on different dates.

Values:

• AlignToCharge
• AlignToSubscriptionStart
• AlignToTermStart

Available for the following charge types:

• Recurring
• Usage-based

Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types:

• One-time
• Recurring
• Usage-based

Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.

Unique number that identifies the tier that the price applies to.

Starting number of a range of units for the tier.

Indicates if pricing is a flat fee or is per unit.

Values:

• FlatFee
• PerUnit

End number of a range of units for the tier.

Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the PriceChangeOption field to SpecificPercentageValue.

Decimal between -100 and 100.

Available for the following charge types:

• Recurring
• Usage-based

Not available for the Fixed-Amount Discount charge model.

Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed? must be set to Yes to use this field.

Values:

• NoChange (default)
• SpecificPercentageValue
• UseLatestProductCatalogPricing

Available for the following charge types:

• Recurring
• Usage-based

Not available for the Fixed-Amount Discount charge model.

Specifies when to start billing the customer for the charge. Required if the triggerEvent field is set to USD.

triggerDate cannot be updated for the following using the REST update subscription call:

• One-time charge type
• Discount-Fixed Amount charge model
• Discount-Percentage charge model

ID of a rate-plan charge for this subscription. It can be the latest version or any history version of ID.

Price for units over the allowed amount.

Available for the following charge type for the Overage and Tiered with Overage charge models:

• Usage-based

Specifies the number of units in the base set of units for this charge. Must be >=0.

Available for the following charge type for the Overage charge model:

• Usage-based

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.

The date when the amendment changes take effect. The format of the date is yyyy-mm-dd.

If there is already a future-dated Update Product amendment on the subscription, the specificUpdateDate field will be used instead of this field to specify when the Update Product amendment takes effect.

ID of a rate plan for this subscription. This can be the latest version or any history version of ID.

The date when the update amendment is activated in yyyy-mm-dd format.

You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the serviceActivationDate field defaults to be the Contract Effective Date.

The billing trigger dates must follow this rule:

contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate

Number of a rate plan for this subscription.

Number of a product rate plan for this subscription.

The date when the Update Product amendment takes effect. This field is only applicable if there is already a future-dated Update Product amendment on the subscription. The format of the date is yyyy-mm-dd.

Required only for Update Product amendments if there is already a future-dated Update Product amendment on the subscription.

Note: This field has been replaced by the invoice field and the collect field. invoiceCollect is available only for backward compatibility.

If true, an invoice is generated and payment collected automatically during the subscription process. If false, no invoicing or payment takes place. The invoice generated in this operation is only for this subscription, not for the entire customer account.

Note: This field is only available if you set the zuora-version request header to 186.0, 187.0, 188.0, or 189.0.

Default value: false