IsNewAmendment

True or False

Required when creating a new amendment. Enter True if applicable; otherwise, enter False. This field cannot be left blank.

Auto Renew

boolean

Optional

Indicates whether the subscription renews automatically or expires at the end of the term.

For TermsAndConditions amendments, this field is required only when updating the automatic renewal status.

Booking Date

string <date>

Optional

Contract Effective Date*

string <date>

Optional

The date on which the amendment becomes effective for billing purposes.

Current Term

int 64

Optional

The length of the current subscription term. This field can be updated only when the Status is Draft.

It is required when Type is TermsAndConditions and TermType is TERMED, but not required when TermType is EVERGREEN.

Values: A valid number.

Current Term Period Type

string

Optional

The period type for the current subscription term.

Required when Type = TermsAndConditions and TermType = TERMED; not required when TermType = EVERGREEN.

This field can be updated only when Status = Draft and is used with the CurrentTerm field to define the current subscription term.

Values: Month (default), Year, Day, Week.

Customer Acceptance Date

string <date>

Optional

The date when the customer accepts the amendment changes to the subscription.

This field is required only if customer acceptance is enabled in Zuora Billing and the subscription status is PendingAcceptance.

When specifying a date in this field, the Status field should be set to Completed.

Description

string

Description of the amendment.

Character limit: 500

Destination Account Id

string

Enter the Id of the subscription owner to whom the subscription will be transferred.

Character limit: 32

Values: a valid account Id

Destination Invoice Owner Id

string

Enter the ID of the invoice owner to whom the subscription will be transferred.

Character limit: 32.

Value: a valid invoice Id

Effective Date

string <date>

The date when the amendment changes take effect. This field validates that the amendment changes fall within the valid ranges of the associated products and product rate plans.

This field is required only when the Type field is set to Cancellation.

Name*

string

Name of the amendment Character

Allowed values: string up to 100 characters.

Options Generate Invoice

boolean

Determines whether an invoice is generated to immediately bill the customer for a new product or changes to Terms and Conditions. As a best practice, set this field to true to help prevent errors that might occur if the account has a balance.

Options Process Payments

boolean

Determines whether payment is collected for the invoice generated by the amend() call.

You can contact Zuora Global Support to configure the maximum number of retries Zuora can perform. The retry count can range from 0 to 2, with a default value of 0. Retrying the request may increase the API call duration, and Zuora does not guarantee the retry will complete within the timeout limit.

Options External Payment Options Effective Date

string (date)

The date when the amendment changes take effect. This field ensures that the amendment changes fall within the valid ranges of the associated products and product rate plans.

This field is required only when the Type field is set to Cancellation.

Options Invoice Processing Options Invoice Target Date*

string (date)

The date that determines which charges to bill. Charges prior to this date or on this date are billed on the resulting invoices.

Options Invoice Processing Options Invoice Date

string (date)

The invoice date.

Options Enable Preview Mode

boolean

Determines whether to create an amendment or display a preview of the change.

Options Include Existing Draft Invoice Items

boolean

Specifies whether to include draft invoice items in amendment previews.

Options Number Of Periods

int 32

Indicates the number of invoice periods to show in a preview.

Options Preview Through Term End

boolean

Request to preview the charge through the end of the subscription term.

Options Preview Type

string

The type of preview you will receive from a preview request.

Options Apply Credit Balance

The priority order in which credit memos and/or unapplied payments are applied to an invoice. Possible values are CreditMemo and UnappliedPayment.

Rate Plan Data Rate Plan Invoice Owner Id*

valid account ID

The invoice owner ID of the subscription to which the rate plan belongs.

Character limit: 32

Rate Plan Data Rate Plan Name*

string

The name of the rate plan.

Character limit: 255

Rate Plan Data Rate Plan Original Rate Plan Id*

valid subscription rate plan ID

The ID of the original subscription rate plan, which corresponds to the rate plan ID of the version-1 subscription.

Character limit: 32

Rate Plan Data Rate Plan Product Rate Plan Id*

valid product rate plan ID

The ID of the associated product rate plan.

Character limit: 32

Rate Plan Data Rate Plan Subscription Id*

valid subscription ID

The ID of the subscription to which the rate plan belongs.

Character limit: 32

Rate Plan Data Rate Plan Subscription Owner Id*

valid account ID

The subscription owner ID of the subscription to which the rate plan belongs.

Character limit: 32

Rate Plan Data Rate Plan Amendment Id

valid amendment ID

The ID of the amendment associated with the rate plan. This field applies only to amendment rate plans.

Character limit: 32

Rate Plan Data Rate Plan Amendment Subscription Rate Plan Id

valid rate plan ID

The ID of the subscription rate plan modified by the amendment.

This field applies only to amendment rate plans.

Character limit: 32

Rate Plan Data Rate Plan Amendment Type

string

The type of amendment associated with the rate plan.

This field applies only to amendment rate plans.

Character limit: 20

Rate Plan Data Rate Plan Externally Managed Plan Id

string

The unique identifier of the rate plan purchased through a third-party store.

This field represents a subscription rate plan created through third-party stores.

Character limit: 32

IsNewAmendmentRatePlanDataRatePlanChargeData

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Bill Cycle Type*

string

Specifies how the billing day for the charge is determined.

Character limit: 20

values: Inherited from ProductRatePlanCharge.BillCycleType.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Billing Period*

string

Allows the billing period to be overridden for a rate plan charge.

values: Inherited from ProductRatePlanCharge.BillingPeriod.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Charge Type*

string

Specifies the charge type.

Character limit: 9

values: Inherited from ProductRatePlanCharge.ChargeType.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Product Rate Plan Charge Id*

string

The ID of the product rate plan charge associated with the subscription rate plan charge.

Character limit: 32

values: Inherited from ProductRatePlanCharge.Id.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Rate Plan Id*

The ID of the rate plan associated with the rate plan charge.

values: Inherited from RatePlan.Id.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Subscription Id*

string

A valid subscription ID.

Character Limit 32

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Trigger Event*

Specifies when billing for the charge begins.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Accounting Code

string

The accounting code associated with the charge. Accounting codes are used to group transactions that share similar accounting attributes.

Character limit: 100

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Apply Discount To

string

Specifies the type of charges to which a particular discount applies.

Character limit: 21

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Bill Cycle Day

int 32

Indicates the charge's Billing Cycle Day (BCD), which determines the day on which bill runs generate invoices for charges associated with the product rate plan charge or the account.

Character limit: 2

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Billing Period Alignment

string

Aligns charges within the same subscription when multiple charges start on different dates.

Character limit: 24

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Billing Timing

string

Specifies the billing timing for the charge. For recurring charge types, billing can occur in advance or in arrears. This field does not apply to one-time or usage-based charge types.

values:

• In Advance
• In Arrears

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Charge Model

string

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

Character limit: 29

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Charge Model Configuration

string

Determines how charges are calculated. Charge models must be individually activated in Zuora Billing administration.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Charge Number

string

A unique identifier for the charge. Although numeric in format, this value is returned as a string. Character limit: 50

values:

• Automatically generated if not provided
• A unique value with up to 50 characters

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Description

string

A description of the charge.

Character limit: 500

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Discount Amount

number (double)

Specifies the amount for a fixed-amount discount. This field can be set only when the ChargeModel field value is Discount-Fixed Amount.

If this field is included in a query, the query returns only rate plans whose ChargeModel is of a discount type.

You cannot query this field together with the following fields in the same query:

• Price
• IncludedUnits
• DiscountPercentage
• OveragePrice

Character limit: 16

values: valid currency amount.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Discount Level

string

Specifies whether the discount applies to the product rate plan, the entire subscription, or any activity within the account.

This field is required only if the ChargeModel field is set to DiscountFixedAmount or DiscountPercentage.

Character limit: 12

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Effective End Date

string (date)

The date when the segmented charge ends or ended.

Character limit: 16

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Effective Start Date

string (date)

The date when the segmented charge starts or started.

Character limit: 16

Rate Plan Data Rate Plan Charge Data Rate Plan Charge End Date Condition

string

Defines when the charge ends after the charge trigger date. This field can be updated only when the Status is Draft.

values:

• SubscriptionEnd – The charge ends on the subscription end date after the charge trigger date. This is the default value.
• FixedPeriod – The charge ends after a specified period from the charge trigger date. If this value is used, you must define the period length and type using the UpToPeriods and UpToPeriodsType fields.
• SpecificEndDate – The charge ends on a specific date. If this value is used, you must specify the date using the SpecificEndDate field.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Charge Function

string

This field is available only when both the Prepaid with Drawdown and Standalone Orders features are enabled. It allows you to use a standalone order to subscribe to a minimum commitment subscription.

This field specifies the type of charge.

Type: Enum

values:

• CommitmentTrueUp – Used for recurring charges. Represents a currency-based minimum commitment charge.
• CreditCommitment – Used for usage charges. Represents credit applied to minimum commitment funds.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Is Stacked Discount

boolean

This field applies only 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 calculated as a stacked discount.

values:

• true – The discount is applied as a stacked discount and is calculated together with other discounts.
• false – The discount is not stacked and is calculated sequentially with other discounts.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge List Price Base

string

Specifies the list price base for the product rate plan charge. This field can be modified only when the amendment type is NewProduct.

Type: Enum

values:

• Per Month
• Per Billing Period
• Per Week
• Per Year
• Per Specific Months

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Number Of Periods

int 64

Specifies the number of periods used to calculate charges in an overage smoothing charge model.

Character limit: 5

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Original Order Date

string (date)

The date when the rate plan charge is created through an order or amendment. This field cannot be updated.

This field standardizes booking date information to improve auditability and data traceability between Zuora Billing and Zuora Revenue. It is mapped to the booking date of a sales order line in Zuora Revenue.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Overage Calculation Option

string (date)

Determines when overage charges are calculated. If SmoothingMode is null (not specified or not inherited from ProductRatePlanCharge.SmoothingMode), this field is ignored.

Character limit: 20.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Overage Unused Units Credit Option

string

Determines whether unused usage units are credited to the customer.

Character limit: 20

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Price Change Option

string

Specifies whether an automatic price change is applied when a termed subscription is renewed.

values:

• NoChange (default)
• SpecificPercentageValue
• UseLatestProductCatalogPricing

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Price Increase Percentage

number (double)

Specifies the percentage used to increase or decrease the price of renewed subscriptions. This field applies only when ProductRatePlanCharge.PriceChangeOption is set to SpecificPercentageValue.

Character limit: 16

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Quantity

number (double)

Specifies the default quantity of units, such as the number of authors in a hosted wiki service. This field is valid for all charge models except Flat Fee pricing. It is required only if the charge model is Per Unit, Tiered Pricing, or Volume Pricing.

Character limit: 16

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Rating Group

string

Specifies the rating group used to determine how usage records are rated.

values:

• ByBillingPeriod (default): Ratings are calculated based on all usage records within a billing period.
• ByUsageStartDate: Ratings are calculated based on all usage records with the same usage start date.
• ByUsageRecord: Ratings are calculated for each individual usage record.
• ByUsageUpload: Ratings are calculated based on all usage records within an uploaded usage file (.xls or .csv).
• ByGroupId: Ratings are calculated based on all usage records within a custom group.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge RevRec Trigger Condition

string

Specifies when revenue recognition begins.

Character limit: 22

Values: ContractEffectiveDate, ServiceActivationDate, CustomerAcceptanceDate

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Revenue Recognition Rule Name

string

Specifies the Revenue Recognition Rule for the Rate Plan Charge.

By default, the rule is inherited from the Product Rate Plan Charge. This field can be updated only when Status = Draft. For Amend calls, it is supported only for NewProduct amendments. For Update calls, it can be used only for subscriptions in draft status. If a rule is specified, it remains unchanged even if the corresponding Product Rate Plan Charge rule is later modified.

Values: Name of an active Revenue Recognition Rule.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Revenue Recognition Code

string

Associates this product rate plan charge with a specific revenue recognition code.

Character limit: 70

Values: valid revenue recognition code

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Specific Billing Period

string

Allows the billing period to be overridden for the rate plan charge.

By default, the value is inherited from ProductRatePlanCharge.BillingPeriod. The inherited value can be overridden only when creating a new subscription or a NewProduct amendment.

Values: Inherited from ProductRatePlanCharge.BillingPeriod.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Specific End Date

string (date)

The specific date when the charge ends, in yyyy-mm-dd format. Applicable only when EndDateCondition = SpecificEndDate.

If the subscription ends before this date, the charge ends with the subscription. If the subscription end date is later changed through a Renewal or TermsAndConditions amendment, the charge ends on the specified end date.

Character limit: 29

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Specific List Price Base

int32 [ 1 .. 200 ]

The number of months used as the list price base for the charge. Required when ListPriceBase = Per Specific Months.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Trigger Date

string (date)

The date when the charge becomes effective and billing begins, in yyyy-mm-dd format. Required only when TriggerEvent = SpecificDate.

Character limit: 29.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Unit of measure

string

Specifies the unit of measure for usage. Units are configured in the web-based UI: Z-Billing > Settings.

Character limit: 25.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Unused Units Credit Rates

integer (double)

Specifies the rate credited to a customer for unused usage units. Applicable only for overage charge models when OverageUnusedUnitsCreditOption = CreditBySpecificRate.Character limit: 16.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Up To Periods

int 64

Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when the period ends.

Character limit: 5 Values: inherited from ProductRatePlanCharge.UpToPeriods

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Up To Periods Type

string

Specifies the period type used to define when the charge ends. This field can be updated only when Status = Draft. Values: Billing Periods (default), Days, Weeks, Months, Years.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Usage Record Rating Option

string

Determines how Zuora processes usage records for per-unit usage charges. Character limit: 18.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Use Discount Specific Accounting Code

boolean

Determines whether to define a new accounting code for the new discount charge. Character limit: 5

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Weekly Bill Cycle Day

string

Values: one of the following: Sunday Monday Tuesday Wednesday Thursday Friday Saturday

IsNewAmendmentRatePlanDataRatePlanChargeDataRatePlanChargeTier

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Tier Rate Plan Charge Id*

string

Required for creating Amendment when modifying tiers

The ID of the subscription or amendment rate plan charge associated with this tier. You can't create an unassociated tier. Character limit: 32

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Tier Ending Unit

number (double)

The end number of a range of units for the tier. This field is only required if the charge mode is Tiered Pricing or Tierred with Overage Pricing. Character limit: 16.

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Tier Is Overage Price

boolean

Indicates if the price is an overage price. An overage occurs when usage surpasses the last defined tier. This field is applicable only to tier pricing and volume pricing models.

Values: true, false

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Tier Price

number (double)

The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the change model is tiered pricing. Character limit: 16 Values: any positive decimal value

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Tier Price Format

string

Indicates if the price is a flat fee or is per unit. Character limit: 8 Values: FlatFee, PerUnit Enum "FlatFee" "PerUnit"

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Tier Starting Unit

number (double)

The start number of a range of units for the tier. This field is only required if the charge mode is Tiered Pricing or Tierred with Overage Pricing.

Character limit: 16 Values: any positive decimal value

Rate Plan Data Rate Plan Charge Data Rate Plan Charge Tier Tier

int 32

A unique number that identifies the tier that the price applies to.

Character limit: 20 Values: automatically generated

IsNewAmendmentRatePlanDataSubscriptionProductFeatureListSubscription

Rate Plan Data Subscription Product Feature List Subscription Product Feature Feature Id*

string

Internal Zuora ID of the feature.

Character limit: 32

Rate Plan Data Subscription Product Feature List Subscription Product Feature Description

string

Description of the subscription product feature.

Character limit: 500

Rate Plan Data Subscription Product Feature List Subscription Product Feature Feature Code

string

Unique code of the feature.

Character limit: 255

Rate Plan Data Subscription Product Feature List Subscription Product Feature Name

string

Name of the feature.

Character limit: 255

Rate Plan Data Subscription Product Feature List Subscription Product Feature Rate Plan Id

string

Specifies the ID of the product rate plan to which the feature belongs.

Character limit: 32

Renewal Setting

string

Optional

Specifies whether a termed subscription remains termed or changes to evergreen upon renewal.

Required: If TermType is Termed.

Allowed values: RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN.

Renewal Term

integer <int64>

Optional

Specifies the renewal term for the amended subscription.

This field can be updated only when the Status is Draft .

Required if Type is TermsAndConditions.

Values: A valid number.

Renewal Term Period Type

string

Optional

Specifies the period type for the subscription renewal term.

Editable only when Status is Draft.

Required when: Type = TermsAndConditions.

Used with RenewalTerm to define the subscription renewal length.

Values: Month (default), Year, Day, Week.

Resume Date

string <date>

The date when the subscription resumes. This field is required only when resuming a suspended subscription.

Service Activation Date

string <date>

Optional

The date when the service is activated.

This field is required only if Zuora is configured to require service activation in Z-Billing and the subscription status is PendingActivation.

Use this field together with the Status field. When setting a service activation date in this field, you must also update the Status field to the next phase status: Completed or PendingAcceptance.

Specific Update Date

string <date>

Optional

The date when the UpdateProduct amendment takes effect.

This field applies only if the subscription already has a future-dated UpdateProduct amendment. In such cases, this field is required.

Status

string

Optional

Specifies the status of the amendment.

Type: String (enum)

values:

• Draft (default if not specified)
• PendingActivation
• PendingAcceptance
• Completed

When entering amendment status values, use the exact system-supported formats shown above. Using spaced versions such as Pending Activation or Pending Acceptance will result in validation errors. Ensure the values are entered exactly as listed to avoid processing failures.

SubType

Suspend Date

string <date>

Optional

The date when the subscription suspension takes effect. This field is required only when suspending an active subscription.

Subscription Id*

string

Optional

ID of the subscription affected by the amendment.

Editable only when Status = Draft.

Limit: 32 characters.

Value: valid subscription ID.

Term Start Date

string <date>

Optional

The date the new terms and conditions take effect.

Required when: Type = TermsAndConditions.

Term Type

string

Specifies whether the subscription is TERMED or EVERGREEN. A TERMED subscription has an expiration date and must be manually renewed. An EVERGREEN subscription does not have an expiration date and must be manually canceled.

When used as part of an amendment with the Type set to TermsAndConditions, this field is required to change the subscription's term type.

Character limit: 9

values: TERMED, EVERGREEN

Type*

string

Optional

Type of amendment. Editable only when Status = Draft. Limit: 18 characters.

Values: Cancellation, NewProduct, OwnerTransfer, RemoveProduct, Renewal, UpdateProduct, TermsAndConditions, SuspendSubscription, ResumeSubscription.