# Amend Modifies a subscription by creating Amendment objects. However, to modify a subscription, Zuora recommends that you use the Create an order operation instead of this action. The Amend action cannot modify the custom fields on the Subscription object. You can use the Create an order operation to modify the custom fields on the Subscription object. You can use this action to create up to 10 Amendment objects. You must specify the following fields for each Amendment object: * ContractEffectiveDate * Name * SubscriptionId * Type Additionally, the value of SubscriptionId must be the same for each Amendment object. You cannot use this operation to update multiple subscriptions. When you call this operation, Zuora modifies the subscription in the order that you specify Amendment objects in the request body. If Zuora is unable to create an Amendment object when you call this operation, the entire call fails. Amendment Preview To view taxation item data for invoices and credit memos in the amendment preview response, you need to set the X-Zuora-WSDL-Version request header to 120 or later. Endpoint: POST /v1/action/amend Version: 2025-12-17 ## Header parameters: - `Idempotency-Key` (string) Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. - `Accept-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. - `Authorization` (string) The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token. - `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 do not need to set this header. - `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 ('). - `X-Zuora-WSDL-Version` (string) Zuora WSDL version number. ## Query parameters: - `rejectUnknownFields` (boolean) Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: json { "message": "Error - unrecognised fields" } By default, Zuora ignores unknown fields in the request body. ## Request fields (application/json): - `requests` (array) The value of this field must be an array that contains a single AmendRequest object. To specify multiple Amendment objects, use the Amendments field of the AmendRequest object. Example: [{"Amendments":[{"Name":"Enable auto-renewal","SubscriptionId":"8ad08ad590a1d7900190a56d87634f5a","Type":"TermsAndConditions","ContractEffectiveDate":"2024-07-12","AutoRenew":true}]}] - `requests.AmendOptions` (object) Use the AmendOptions container to specify billing options, such as invoice generation and when to process payments. - `requests.AmendOptions.ApplicationOrder` (array) The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: CreditMemo, UnappliedPayment. Note: - This field is only available if you have the Invoice Settlement feature enabled and set the X-Zuora-WSDL-Version request header to 107 or later. - 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. - `requests.AmendOptions.ApplyCredit` (boolean) If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. Note: This field is only available if you have the Invoice Settlement feature enabled and set the X-Zuora-WSDL-Version request header to 107 or later. - `requests.AmendOptions.ApplyCreditBalance` (boolean) - `requests.AmendOptions.ElectronicPaymentOptions` (object) - `requests.AmendOptions.ElectronicPaymentOptions.PaymentMethodId` (string) - `requests.AmendOptions.ExternalPaymentOptions` (object) - `requests.AmendOptions.ExternalPaymentOptions.Amount` (number) - `requests.AmendOptions.ExternalPaymentOptions.EffectiveDate` (string) - `requests.AmendOptions.ExternalPaymentOptions.GatewayOrderId` (string) - `requests.AmendOptions.ExternalPaymentOptions.ReferenceId` (string) - `requests.AmendOptions.GenerateInvoice` (boolean) Determines whether to generate an invoice to immediately bill the customer for a new product or changes of Terms And Conditions. As a best practice, set this value to true to prevent any errors that might occur if the account has a balance. Note: * Even if you do not include this field in the amend action, Zuora still parses this field with the default value - true, when processing the amend action. If you do not want to generate the invoice after creating the New Product or Term And Condition amendment, set the value of this field to false in the request. * If EnablePreviewMode=true is specified in the PreviewOptions container, then preview mode will be enabled and an invoice will not be generated, regardless of whether GenerateInvoice is specified as true or false. - `requests.AmendOptions.InvoiceProcessingOptions` (object) - `requests.AmendOptions.InvoiceProcessingOptions.InvoiceDate` (string) The invoice date. - `requests.AmendOptions.InvoiceProcessingOptions.InvoiceTargetDate` (string, required) The date that determines which charges to bill. Charges prior to this date or on this date are billed on the resulting invoices. - `requests.AmendOptions.ProcessPayments` (boolean) Determines whether to collect payment against the invoice generated by the amend() call. Note: * Even if you do not include this field in the amend action, Zuora still parses this field with the default value, true, when processing the amend action. If you do not want to collect payment against the generated invoice after creating the New Product or Term And Condition amendment, set the value of this field to false in the request. If a temporary error that Zuora cannot create or submit a payment to the gateway is seen, Zuora will automatically retry the action to collect the payment. You can contact [Zuora Global Support](https://support.zuora.com/) to set the maximum number of retries that Zuora can perform. The number can range from 0 to 2 with a default value of 0. However, retrying the request can make the API call take longer than expected. Zuora does not guarantee the retry could be completed within the timeout limit. Note: The retry mechanism does not support the preview mode of the amend() call. - `requests.Amendments` (array, required) The Amendment object holds the changes that you want to make to the Subscription specified by the SubscriptionId, including its RatePlan, RatePlanCharge, and RatePlanChargeTier. - `requests.Amendments.AutoRenew` (boolean) Determines whether the subscription is automatically renewed, or whether it expires at the end of the term and needs to be manually renewed. For amendment of type TermsAndConditions, this field is only required if you change the automatic renewal status of a subscription. Values: true, false - `requests.Amendments.Code` (string) A unique alphanumeric string that identifies the amendment. Character limit: 50 Values: automatically generated - `requests.Amendments.ContractEffectiveDate` (string, required) The date when the amendment's changes become effective for billing purposes. - `requests.Amendments.CreatedById` (string) The user ID of the person who created the amendment. Character limit: 32 Values: automatically generated - `requests.Amendments.CreatedDate` (string) The date when the amendment was created. Values: automatically generated - `requests.Amendments.CurrentTerm` (integer) The length of the period for the current subscription term. This field can be updated when Status is Draft. This field is only required if the Type field is set to TermsAndConditions and TermType is set to TERMED. This field is not required if TermType is set to EVERGREEN. Values: a valid number - `requests.Amendments.CurrentTermPeriodType` (string) The period type for the current subscription term. This field is only required if the Type field is set to TermsAndConditions and TermType is set to TERMED. This field is not required if TermType is set to EVERGREEN. Values: - Month (default) - Year - Day - Week Note: - This field can be updated when Status is Draft. - This field is used with the CurrentTerm field to specify the current subscription term. - `requests.Amendments.CustomerAcceptanceDate` (string) The date when the customer accepts the amendment's changes to the subscription. This field is only required if [Zuora is configured to require customer acceptance in Z-Billing](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/Define_Default_Subscription_Settings) and the subscription is currently in the Pending Acceptance status (the value of the Status field is currently PendingAcceptance). Use this field together with the Status field. When you set a date in this field as a customer acceptance date, you should also set the Status field as Completed. - `requests.Amendments.Description` (string) A description of the amendment. Character limit: 500 Values: maximum 500 characters - `requests.Amendments.DestinationAccountId` (string) The ID of the subscription owner that the subscription is being transferred to. Character limit: 32 Values: a valid account ID - `requests.Amendments.DestinationInvoiceOwnerId` (string) The ID of the invoice owner that the subscription is being transferred to. Character limit: 32 Values: a valid invoice ID - `requests.Amendments.EffectiveDate` (string) The date when the amendment's changes take effective. This field validates that the amendment's changes are within valid ranges of products and product rate plans. This field is only required if the Type field is set to Cancellation. - `requests.Amendments.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" - `requests.Amendments.Name` (string, required) The name of the amendment. Character limit: 100 Values: a string of 100 characters or fewer - `requests.Amendments.RatePlanData` (object) A container for one RatePlanData. This field is only required if the Type field is set to NewProduct, RemoveProduct, or UpdateProduct. - `requests.Amendments.RatePlanData.RatePlan` (object, required) - `requests.Amendments.RatePlanData.RatePlan.ProductRatePlanId` (string) Internal identifier of the product rate plan that the rate plan is based on. - `requests.Amendments.RatePlanData.RatePlan.AmendmentSubscriptionRatePlanId` (string) ID of the subscription rate plan that will be amended. This field is required when creating an UpdateProduct or RemoveProduct type of amendment. - `requests.Amendments.RatePlanData.RatePlanChargeData` (array) - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge` (object, required) Container for custom fields of a Subscription object. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.AccountingCode` (string) The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes. Character limit: 100 Values: inherited from ProductRatePlanCharge.AccountingCode - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.ApplyDiscountTo` (string) Specifies the type of charges a specific discount applies to. Character limit: 21 Values: inherited from ProductRatePlanCharge.ApplyDiscountTo - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.BillCycleDay` (integer) Indicates the charge's billing cycle day (BCD), which is when bill runs generate invoices for charges associated with the product rate plan charge or the account. Character limit: 2 Values: inherited from ProductRatePlanCharge.BillCycleDay - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.BillCycleType` (string) Specifies how to determine the billing day for the charge. Character limit: 20 Values: inherited from ProductRatePlanCharge.BillCycleType Note: You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.BillingPeriod` (string) Allows billing period to be overridden on rate plan charge. Values: inherited from ProductRatePlanCharge.BillingPeriod Note: You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.BillingPeriodAlignment` (string) Aligns charges within the same subscription if multiple charges begin on different dates. Character limit: 24 Values: inherited from ProductRatePlanCharge.BillingPeriodAlignment - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.BillingTiming` (string) The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types. Character limit: Values: one of the following: - In Advance - In Arrears Note: You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.ChargeModel` (string) Determines how to evaluate charges. Charge models must be individually activated in the web-based UI. Character limit: 29 Values: inherited from ProductRatePlanCharge.ChargeModel - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.ChargeNumber` (string) A unique number that identifies the charge. This number is returned as a string. Character limit: 50 Values: one of the following: - automatically generated if left null - a unique number of 50 characters or fewer - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.ChargeType` (string) Specifies the type of charge. Character limit: 9 Values: inherited from ProductRatePlanCharge.ChargeType - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.ChargedThroughDate` (string) The date through which a customer has been billed for the charge. Character limit: 29 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.CreatedById` (string) The ID of the Zuora user who created the RatePlanCharge object. Character limit: 32 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.CreatedDate` (string) The date when the RatePlanCharge object was created. Character limit: 29 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.DMRC` (number) A delta monthly recurring charge is the change in monthly recurring revenue caused by an amendment or a new subscription. Character limit: 16 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.DTCV` (number) After an Amendment, the change in the total contract value (TCV) amount for this charge, compared with its previous value. Character limit: 16 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.Description` (string) A description of the charge. Character limit: 500 Values: inherited from ProductRatePlanCharge.Description - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.DiscountAmount` (number) Specifies the amount of a fixed-amount discount. You can provide a value for this field if the ChargeModel field value is Discount-Fixed Amount. If this field is included in a query, the query will filter out the rate plans whose ChargeModel field is not of a Discount type. You cannot query this field with the following fields in a single query: - Price - IncludedUnits - DiscountPercentage - OveragePrice Character limit: 16 Values: a valid currency amount - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.DiscountLevel` (string) Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account. This field is only required if the ChargeModel field is set to DiscountFixedAmount or DiscountPercentage. Character limit: 12 Values: inherited from ProductRatePlanCharge.DiscountLevel - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.DiscountPercentage` (number) Query Filter - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.EffectiveEndDate` (string) The date when the segmented charge ends or ended. Character limit: 16 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.EffectiveStartDate` (string) The date when the segmented charge starts or started. Character limit: 16 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.EndDateCondition` (string) Defines when the charge ends after the charge trigger date. This field can be updated when Status is Draft. Values: one of the following: - 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 based on the trigger date of the charge. If you set this field to FixedPeriod, you must specify the length of the period and a period type by defining the UpToPeriods and UpToPeriodsType fields. - SpecificEndDate: The specific date on which the charge ends. If you set this field to SpecificEndDate, you must specify the specific date by defining the SpecificEndDate field. Note: 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. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.IncludedUnits` (number) Query Filter - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.IsLastSegment` (boolean) Indicates if the segment of the rate plan charge is the most recent segment. Character limit: 5 Values: automatically generated: true, false - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.ListPriceBase` (string) The list price base for the product rate plan charge. You can only change the value of this field if the amendment type is NewProduct. Enum: "Per Month", "Per Billing Period", "Per Week", "Per Year", "Per Specific Months" - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.MRR` (number) Monthly recurring revenue (MRR) is the amount of recurring charges in a given month. The MRR calculation doesn't include one-time charges nor usage charges. Character limit: 16 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.Name` (string) The name of the rate plan charge. Character limit: 100 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.NumberOfPeriods` (integer) Specifies the number of periods to use when calculating charges in an overage smoothing charge model. Character limit: 5 Values: inherited from ProductRatePlanCharge.NumberOfPeriod - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.OriginalId` (string) The original ID of the rate plan charge. Character limit: 32 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.OverageCalculationOption` (string) Determines when to calculate overage charges. If the value of the SmoothingMode field is null (not specified and not inherited from ProductRatePlanCharge.SmoothingMode), the value of this field is ignored. Character limit: 20 Values: inherited from ProductRatePlanCharge.OverageCalculationOption - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.OveragePrice` (number) Query Filter - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.OverageUnusedUnitsCreditOption` (string) Determines whether to credit the customer with unused units of usage. Character limit: 20 Values: inherited from ProductRatePlanCharge.OverageUnusedUnitsCreditOption - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.Price` (number) Query Filter - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.PriceChangeOption` (string) Applies an automatic price change when a termed subscription is renewed. Character limit: Values: one of the following: - NoChange (default) - SpecificPercentageValue - UseLatestProductCatalogPricing - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.PriceIncreasePercentage` (number) Specifies the percentage to increase or decrease the price of renewed subscriptions. Use this field if the ProductRatePlanCharge.PriceChangeOption value is set to SpecificPercentageValue. Character limit: 16 Values: a decimal value between -100 and 100 - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.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. Character limit: 29 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.ProductRatePlanChargeId` (string, required) The ID of the product rate plan charge associated with the subscription rate plan charge, Character limit: 32 Values: inherited from ProductRatePlanCharge.Id - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.Quantity` (number) The default quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing. This field is only rquired if the charge model is per unit, tiered pricing, or volume pricing. Character limit: 16 Values: a valid quantity value - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.RatePlanId` (string) The ID of the rate plan associated with the rate plan charge. Character limit: 32 Values: inherited from RatePlan.Id - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.RevRecCode` (string) Associates this product rate plan charge with a specific revenue recognition code. Character limit: 70 Values: a valid revenue recognition code - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.RevRecTriggerCondition` (string) Specifies when revenue recognition begins. Character limit: 22 Values: one of the following: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.RevenueRecognitionRuleName` (string) Specifies the Revenue Recognition Rule that you want the Rate Plan Charge to use. This field can be updated when Status is Draft. By default, the Revenue Recognition Rule is inherited from the Product Rate Plan Charge. For Amend calls, you can use this field only for NewProduct amendments. For Update calls, you can use this field only to update subscriptions in draft status. Note that if you use this field to specify a Revenue Recognition Rule for the Rate Plan Charge, the rule will remain as specified even if you later change the rule used by the corresponding Product Rate Plan Charge. See [Z-Billing User Role](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) permission enabled to use this field. Character limit: n/a Values: name of an active Revenue Recognition Rule - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.RolloverBalance` (number) Specifies the number of units of measure (UOM) rolled over from previous periods. This field is applicable only to usage charges with overage models. Character limit: 16 Values: automatically generated Note: - You cannot query or filter this field with other fields in a single query. - To query or filter this field, you must specify and only specify the rate plan charge Id in the condition. - You cannot use this field in the query or filter condition. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.Segment` (integer) The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1. Character limit: 2 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.SpecificBillingPeriod` (integer) Customizes the number of months or weeks for the charges billing period. This field is only required if you set the value of the BillingPeriod field to Specific Months or Specific Weeks. Character limit: 5 Values: inherited from ProductRatePlanCharge.BillingPeriod Note: You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.SpecificEndDate` (string) The specific date on which the charge ends, in yyyy-mm-dd format. Character limit: 29 Note: - This field is only applicable when the EndDateCondition field is set to SpecificEndDate. - If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.SpecificListPriceBase` (integer) 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. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.TCV` (number) The total contract value (TCV) is the value of a single rate plan charge in a subscription over the lifetime of the subscription. This value does not represent all charges on the subscription. The TCV includes recurring charges and one-time charges, but it doesn't include usage charge. Character limit: 16 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.TriggerDate` (string) The date when the charge becomes effective and billing begins, in yyyy-mm-dd format. This field is only required if the TriggerEvent field is set to SpecificDate. Character limit: 29 - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.TriggerEvent` (string) Specifies when to start billing the customer for the charge. Note: This field can be passed through the subscribe and amend calls and will override the default value set on the Product Rate Plan Charge. Character limit: 18 Values: inherited from ProductRatePlanCharge.TriggerEvent and can be one of the following values: - ContractEffective is the date when the subscription's contract goes into effect and the charge is ready to be billed. - ServiceActivationDate is when the services or products for a subscription have been activated and the customers have access. - CustomerAcceptance is when the customer accepts the services or products for a subscription. - SpecificDate is valid only on the RatePlanCharge. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.UOM` (string) Specifies the units to measure usage. Units of measure are configured in the web-based UI: Z-Billing > Settings. Character limit: 25 Values: inherited from ProductRatePlanCharge.UOM - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.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. Character limit: 16 Values: a valid decimal value - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.UpToPeriods` (integer) Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends. Character limit: 5 Values: inherited from ProductRatePlanCharge.UpToPeriods Note: - You must use this field together with the UpToPeriodsType field to specify the time period. This field is only applicable only when the EndDateCondition field is set to FixedPeriod. - You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - Use this field to override the value in ProductRatePlanCharge.UpToPeriod. - If you override the value in this field, enter a whole number between 0 and 65535, exclusive. - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.UpToPeriodsType` (string) The period type used to define when the charge ends. This field can be updated when Status is Draft. Values: one of the following: - Billing Periods (default) - Days - Weeks - Months - Years Note: - You must use this field together with the UpToPeriods field to specify the time period. - This field is only applicable only when the EndDateCondition field is set to FixedPeriod. - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.UpdatedById` (string) The ID of the last user to update the object. Character limit: 32 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.UpdatedDate` (string) The date when the object was last updated. Character limit: 29 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.UsageRecordRatingOption` (string) Determines how Zuora processes usage records for per-unit usage charges. Character limit: 18 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.UseDiscountSpecificAccountingCode` (boolean) Determines whether to define a new accounting code for the new discount charge. Character limit: 5 Values: inherited from ProductRatePlanCharge.UseDiscountSpecificAccountingCode - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.Version` (integer) The version of the rate plan charge. Each time a charge is amended, Zuora creates a new version of the rate plan charge. Character limit: 5 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanCharge.WeeklyBillCycleDay` (string) Specifies which day of the week as the bill cycle day (BCD) for the charge. This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Values: one of the following: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier` (array) - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.CreatedById` (string) The ID of the Zuora user who created the RatePlanChargeTier object. Character limit: 32 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.CreatedDate` (string) The date when the RatePlanChargeTier object was created. Character limit: 29 Values: automatically generated - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.EndingUnit` (number) 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 Values: any positive decimal value - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.IsOveragePrice` (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 - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.Price` (number) 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 - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.PriceFormat` (string) Indicates if the price is a flat fee or is per unit. Character limit: 8 Values: FlatFee, PerUnit Enum: "FlatFee", "PerUnit" - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.RatePlanChargeId` (string, required) The ID of the subscription or amendment rate plan charge associated with this tier. You can't create an unassociated tier. Character limit: 32 Values: inherited from RatePlanCharge.Id - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.StartingUnit` (number) 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 - `requests.Amendments.RatePlanData.RatePlanChargeData.RatePlanChargeTier.Tier` (integer) A unique number that identifies the tier that the price applies to. Character limit: 20 Values: automatically generated - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList` (object) - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature` (array) - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.CreatedById` (string) - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.CreatedDate` (string) Date and time when the product feature was added to the subscription. Character limit: 29 Values: - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.Description` (string) Description of the subscription product feature. Character limit: 500 Values: - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.FeatureCode` (string) Unique code of the feature. Character limit: 255 Values: - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.FeatureId` (string) Internal Zuora ID of the feature. Character limit: 32 Values: - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.Name` (string) Name of the feature. Character limit: 255 Values: - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.RatePlanId` (string) Id of the product rate plan to which the feature belongs. Character limit: 32 Values: - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.UpdatedById` (string) Internal Zuora ID of the user who last updated the subscription product feature. Character limit: 32 Values: - `requests.Amendments.RatePlanData.SubscriptionProductFeatureList.SubscriptionProductFeature.UpdatedDate` (string) Date and time when the subscription product feature was last updated. Character limit: 29 Values: - `requests.Amendments.RenewalSetting` (string) Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed. This field is only required if the TermType field is set to Termed. Values: RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN - `requests.Amendments.RenewalTerm` (integer) The term of renewal for the amended subscription. This field can be updated when Status is Draft. This field is only required if the Type field is set to TermsAndConditions. Values: a valid number - `requests.Amendments.RenewalTermPeriodType` (string) The period type for the subscription renewal term. This field can be updated when Status is Draft. Required: Only if the value of the Type field is set to TermsAndConditions. This field is used with the RenewalTerm field to specify the subscription renewal term. Values: - Month (default) - Year - Day - Week - `requests.Amendments.ResumeDate` (string) The date when the subscription resumption takes effect. See [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date) for more information. This field is only required if you resume a suspended subscription. - `requests.Amendments.ServiceActivationDate` (string) The date when service is activated. This field is only required if [Zuora is configured to require service activation in Z-Billing](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/Define_Default_Subscription_Settings) and the subscription is currently in the PendingActivation status (the value of the Status field is currently PendingActivation). Use this field together with the Status field. When you set a date in this field as a service activation date, you should also set the Status field as the expected next phase status: Completed or PendingAcceptance. - `requests.Amendments.SpecificUpdateDate` (string) The date when the UpdateProduct amendment takes effect. This field is only applicable if there is already a future-dated UpdateProduct amendment on the subscription. For the UpdateProduct amendments, this field is only required if there is already a future-dated UpdateProduct amendment on the subscription. - `requests.Amendments.Status` (string) The status of the amendment. Type: string (enum) Values: one of the following: - Draft (default, if left null) - PendingActivation - PendingAcceptance - Completed - `requests.Amendments.SubscriptionId` (string, required) The ID of the subscription that the amendment changes. The ID can be the latest version or any history version of ID. Character limit: 32 Values: a valid subscription ID - `requests.Amendments.SuspendDate` (string) The date when the subscription suspension takes effect. See [Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date) for more information. This field is only required if you suspend an active subscription. - `requests.Amendments.TermStartDate` (string) The date when the new terms and conditions take effect. This field is only required if the Type field is set to TermsAndConditions. - `requests.Amendments.TermType` (string) Indicates if the subscription isTERMED or EVERGREEN. - A TERMED subscription has an expiration date, and must be manually renewed. - An EVERGREEN subscription doesn't have an expiration date, and must be manually ended. When as part of an amendment of type TermsAndConditions, this field is required to change the term type of a subscription. Character limit: 9 Values: TERMED, EVERGREEN - `requests.Amendments.Type` (string, required) The type of amendment. Character limit: 20 Values: one of the following: - Cancellation - NewProduct - OwnerTransfer (If this value is chosen, the ContractEffectiveDate, ServiceActivationDate, and CustomerAcceptanceDate fields will all be automatically set to today's date, and any values passed from the API are ignored.) - RemoveProduct - Renewal - UpdateProduct - TermsAndConditions - SuspendSubscription - ResumeSubscription - `requests.Amendments.UpdatedById` (string) The ID of the user who last updated the amendment. Character limit: 32 Values: automatically generated - `requests.Amendments.UpdatedDate` (string) The date when the amendment was last updated. Values: automatically generated - `requests.Amendments.BookingDate` (string) The date when the amendment is signed. If you didn't specify this field, the date is automatically set to the amendment created-on date. 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. Note: This field is only available if you set the X-Zuora-WSDL-Version header parameter to 120 or later. - `requests.PreviewOptions` (object) Use the PreviewOptions container to preview an amendment before committing its changes to a subscription. You can use a preview to provide a quote of the new charges to a customer before the customer commits to the amended subscription. For example, make an Amend call with an Amendment object that removes an existing rate plan, another Amendment object that adds a new rate plan, and turn on the preview options. - `requests.PreviewOptions.EnablePreviewMode` (boolean) Determines whether to create an amendment or display a preview of the change. - `requests.PreviewOptions.IncludeExistingDraftInvoiceItems` (boolean) Specifies whether to include draft invoice items in amendment previews. - `requests.PreviewOptions.NumberOfPeriods` (integer) Indicates the number of invoice periods to show in a preview. - `requests.PreviewOptions.PreviewThroughTermEnd` (boolean) Request to preview the charge through the end of the subscription term. - `requests.PreviewOptions.PreviewType` (string) The type of preview you will receive from a preview request. ## Response 200 fields (application/json): - `results` (array) - `results.AmendmentIds` (array) A list of the IDs of the associated amendments. There can be as many as three amendment IDs. Use a comma to separate each amendment ID. - `results.ChargeMetricsData` (object) - `results.ChargeMetricsData.ChargeMetrics` (array) - `results.ChargeMetricsData.ChargeMetrics.ChargeNumber` (string) - `results.ChargeMetricsData.ChargeMetrics.DMRR` (number) - `results.ChargeMetricsData.ChargeMetrics.DTCV` (number) - `results.ChargeMetricsData.ChargeMetrics.MRR` (number) - `results.ChargeMetricsData.ChargeMetrics.OriginalId` (string) - `results.ChargeMetricsData.ChargeMetrics.OriginalRatePlanId` (string) - `results.ChargeMetricsData.ChargeMetrics.ProductRatePlanChargeId` (string) - `results.ChargeMetricsData.ChargeMetrics.ProductRatePlanId` (string) - `results.ChargeMetricsData.ChargeMetrics.TCV` (number) - `results.CreditMemoDatas` (array) - `results.CreditMemoDatas.CreditMemo` (object) Container for credit memos. Note: This container is only available if you set the WSDL minor version to 107.0 or later in the request header, and 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. - `results.CreditMemoDatas.CreditMemo.TaxAmount` (number) Tax amount on the credit memo. - `results.CreditMemoDatas.CreditMemo.TotalAmount` (number) Credit memo amount. - `results.CreditMemoDatas.CreditMemo.TotalAmountWithoutTax` (number) Credit memo amount minus tax. - `results.CreditMemoDatas.CreditMemoItem` (array) - `results.CreditMemoDatas.CreditMemoItem.AmountWithoutTax` (number) The credit memo item amount excluding tax. - `results.CreditMemoDatas.CreditMemoItem.ChargeName` (string) Name of this credit memo item. - `results.CreditMemoDatas.CreditMemoItem.Description` (string) Description of this credit memo item. - `results.CreditMemoDatas.CreditMemoItem.ProductRatePlanChargeId` (string) ID of the product rate plan charge associated with this credit memo item. - `results.CreditMemoDatas.CreditMemoItem.Quantity` (integer) Quantity of the charge associated with this credit memo item. - `results.CreditMemoDatas.CreditMemoItem.ServiceEndDate` (string) End date of the service period for this credit memo item, as yyyy-mm-dd. - `results.CreditMemoDatas.CreditMemoItem.ServiceStartDate` (string) Service start date of this credit memo item, as yyyy-mm-dd. - `results.CreditMemoDatas.CreditMemoItem.TaxAmount` (number) The tax amount of the credit memo item. - `results.CreditMemoDatas.CreditMemoItem.UnitOfMeasure` (string) Unit used to measure consumption. - `results.CreditMemoDatas.TaxationItemData` (array) List of taxation items. Note: This field is only available if you set the X-Zuora-WSDL-Version request header to 120 or later. - `results.CreditMemoDatas.TaxationItemData.CreditMemoItemId` (string) The ID of the credit memo item associated with the taxation item. - `results.CreditMemoDatas.TaxationItemData.ExemptAmount` (number) The calculated tax amount excluded due to the exemption. - `results.CreditMemoDatas.TaxationItemData.Jurisdiction` (string) The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. - `results.CreditMemoDatas.TaxationItemData.LocationCode` (string) The identifier for the location based on the value of the TaxCode field. - `results.CreditMemoDatas.TaxationItemData.Name` (string) The name of the taxation item. - `results.CreditMemoDatas.TaxationItemData.TaxAmount` (number) The amount of the tax applied to the credit memo. - `results.CreditMemoDatas.TaxationItemData.TaxCode` (string) The tax code identifies which tax rules and tax rates to apply to a specific credit memo. - `results.CreditMemoDatas.TaxationItemData.TaxCodeDescription` (string) The description of the tax code. - `results.CreditMemoDatas.TaxationItemData.TaxDate` (string) The date when the tax is applied to the credit memo. - `results.CreditMemoDatas.TaxationItemData.TaxRate` (number) The tax rate applied to the credit memo. - `results.CreditMemoDatas.TaxationItemData.TaxRateDescription` (string) The description of the tax rate. - `results.CreditMemoDatas.TaxationItemData.TaxRateType` (string) The type of the tax rate applied to the credit memo. Enum: "Percentage", "FlatFee" - `results.CreditMemoId` (string) - `results.Errors` (array) - `results.Errors.Code` (string) - `results.Errors.Message` (string) - `results.GatewayResponse` (string) - `results.GatewayResponseCode` (string) - `results.InvoiceDatas` (array) This array of invoices contains one invoice only as one invoice is generated for one subscription. - `results.InvoiceDatas.Invoice` (object) - `results.InvoiceDatas.Invoice.AccountId` (string) - `results.InvoiceDatas.Invoice.AdjustmentAmount` (number) The amount of the invoice adjustments associated with the invoice. Character limit: 16 Values: a valid currency amount - `results.InvoiceDatas.Invoice.Amount` (number) The sum of all charges and taxes associated with the invoice. Character limit: 16 Values: automatically generated - `results.InvoiceDatas.Invoice.AmountWithoutTax` (number) The sum of all charges associated with the invoice. Taxes are excluded from this value. Character limit: 16 Values: automatically generated - `results.InvoiceDatas.Invoice.Balance` (number) The remaining balance of the invoice after all payments, adjustments, and refunds are applied. Character limit: 16 Values: automatically generated - `results.InvoiceDatas.Invoice.BillRunId` (string) The ID of a Bill Run. Character limit: 32 Values: a BillRun ID - `results.InvoiceDatas.Invoice.Body` (string) Required - `results.InvoiceDatas.Invoice.Comments` (string) Additional information related to the invoice that a Zuora user added to the invoice. Character limit: 255 Values: a string of 255 characters or fewer - `results.InvoiceDatas.Invoice.CreatedById` (string) The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run. Character limit: 32 Values: automatically generated - `results.InvoiceDatas.Invoice.CreatedDate` (string) The date when the invoice was generated. Character limit: 29 Values: automatically generated - `results.InvoiceDatas.Invoice.CreditBalanceAdjustmentAmount` (number) The currency amount of the adjustment applied to the customer's credit balance. Character limit: 16 Values: a valid currency amount This field is only available if the [Zuora Global Support](http://support.zuora.com/) to enable this feature. - `results.InvoiceDatas.Invoice.DueDate` (string) The date by which the payment for this invoice is due. Character limit: 29 - `results.InvoiceDatas.Invoice.IncludesOneTime` (boolean) Specifies whether the invoice includes one-time charges. Character limit: 5 Values: automatically generated from one of the following: True (default), False - `results.InvoiceDatas.Invoice.IncludesRecurring` (boolean) Specifies whether the invoice includes recurring charges. Character limit: 5 Values: automatically generated from one of the following: True (default), False - `results.InvoiceDatas.Invoice.IncludesUsage` (boolean) Specifies whether the invoice includes usage charges. Character limit: 5 Values: automatically generated from one of the following: True (default), False - `results.InvoiceDatas.Invoice.InvoiceDate` (string) Specifies the date on which to generate the invoice. Character limit: 29 - `results.InvoiceDatas.Invoice.InvoiceNumber` (string) The unique identification number for the invoice. This number is returned as a string. Character limit: 32 Values: automatically generated - `results.InvoiceDatas.Invoice.LastEmailSentDate` (string) The date when the invoice was last emailed. Character limit: 29 Values: automatically generated - `results.InvoiceDatas.Invoice.PaymentAmount` (number) The amount of payments applied to the invoice. Character limit: 16 Values: automatically generated - `results.InvoiceDatas.Invoice.PostedBy` (string) The user ID of the person who moved the invoice to Posted status. Character limit: 32 Values: automatically generated - `results.InvoiceDatas.Invoice.PostedDate` (string) The date when the invoice was posted. Character limit: 29 Values: automatically generated - `results.InvoiceDatas.Invoice.RefundAmount` (number) Specifies the amount of a refund that was applied against an earlier payment on the invoice. Character limit: 16 Values: automatically generated - `results.InvoiceDatas.Invoice.RegenerateInvoicePDF` (boolean) Regenerates a PDF of an invoice that was already generated. Character limit: 5 Values: True, False - `results.InvoiceDatas.Invoice.Status` (string) The status of the invoice in the system. This status is not the status of the payment of the invoice, just the status of the invoice itself. Character limit: 8 Values: one of the following: - Draft (default, automatically set upon invoice creation) - Posted - Canceled - `results.InvoiceDatas.Invoice.TargetDate` (string) This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run. Character limit: 29 - `results.InvoiceDatas.Invoice.TaxAmount` (number) The total amount of the taxes applied to the invoice. Character limit: 16 Values: automatically generated - `results.InvoiceDatas.Invoice.TaxExemptAmount` (number) The calculated tax amount excluded due to the exemption. Character limit: 16 Values: automatically generated - `results.InvoiceDatas.Invoice.TransferredToAccounting` (string) Specifies whether or not the invoice was transferred to an external accounting system, such as NetSuite. Character limit: 10 Values: Processing, Yes, Error, Ignore - `results.InvoiceDatas.Invoice.UpdatedById` (string) - `results.InvoiceDatas.Invoice.UpdatedDate` (string) The date when the invoice was last updated. Character limit: 29 Values: automatically generated - `results.InvoiceDatas.InvoiceItem` (array) - `results.InvoiceDatas.InvoiceItem.AccountingCode` (string) The accounting code for the item's charge. Accounting codes group transactions that contain similar accounting attributes. Character limit: 100 Values: inherited from RatePlanCharge.AccountingCode - `results.InvoiceDatas.InvoiceItem.AppliedToInvoiceItemId` (string) Associates a discount invoice item to a specific invoice item. Character limit: 32 Values: inherited from the ID of the charge that a discount applies to - `results.InvoiceDatas.InvoiceItem.ChargeAmount` (number) The amount being charged for the invoice item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive. Character limit: Values: automatically calculated from multiple fields in multiple objects - `results.InvoiceDatas.InvoiceItem.ChargeDate` (string) The date when the Invoice Item is created . Character limit: 29 Values: automatically generated - `results.InvoiceDatas.InvoiceItem.ChargeDescription` (string) A description of the invoice item's charge. Character limit: 500 Values: inherited from RatePlanCharge.Description - `results.InvoiceDatas.InvoiceItem.ChargeId` (string) The ID of the rate plan charge that is associated with this invoice item upon object creation. Character limit: 32 Values: inherited from RatePlanCharge.Id - `results.InvoiceDatas.InvoiceItem.ChargeName` (string) The name of the invoice item's charge. Character limit: 50 Values: inherited from RatePlanCharge.Name - `results.InvoiceDatas.InvoiceItem.ChargeNumber` (string) The unique identifier of the invoice item's charge. Character limit: 50 Values: inherited from RatePlanCharge.ChargeNumber - `results.InvoiceDatas.InvoiceItem.ChargeType` (string) Specifies the type of charge. Character limit: 9 Values: one of the following: - OneTime - Recurring - Usage - `results.InvoiceDatas.InvoiceItem.CreatedById` (string) The user ID of the person who created the invoice item. Character limit: 32 Values: automatically generated - `results.InvoiceDatas.InvoiceItem.CreatedDate` (string) The date the invoice item was created. Character limit: 29 Values: automatically generated - `results.InvoiceDatas.InvoiceItem.InvoiceId` (string) The ID of the invoice that's associated with this invoice item. Character limit: 32 Values: inherited from Invoice.Id - `results.InvoiceDatas.InvoiceItem.ProcessingType` (number) Identifies the kind of charge where 0 is a charge, 1 is a discount, 2 is a prepayment, and 3 is a tax. The returned value is text not decimal on data sources. Character limit: Values: - 0: charge - 1: discount - 2: prepayment - 3: tax - `results.InvoiceDatas.InvoiceItem.ProductDescription` (string) A description of the product associated with this invoice item. Character limit: 500 Values: inherited from Product.Description - `results.InvoiceDatas.InvoiceItem.ProductId` (string) The ID of the product associated with this invoice item. Character limit: 32 Values: inherited from Product.Id - `results.InvoiceDatas.InvoiceItem.ProductName` (string) The name of the product associated with this invoice item. Character limit: 255 Values: inherited from Product.Name - `results.InvoiceDatas.InvoiceItem.ProductRatePlanChargeId` (string) The ID of the rate plan charge that's associated with this invoice item. Character limit: 32 Values: inherited from ProductRatePlanCharge.Id You cannot query for this field. Only the subscribe preview and the amend preview calls will return the value of this field in the response. - `results.InvoiceDatas.InvoiceItem.Quantity` (number) The number of units for this invoice item. Values: inherited from RatePlanCharge.Quantity - `results.InvoiceDatas.InvoiceItem.RatePlanChargeId` (string) The ID of the rate plan charge that's associated with this invoice item. Character limit: 32 Values: inherited from RatePlanCharge.Id - `results.InvoiceDatas.InvoiceItem.RevRecCode` (string) Associates this invoice item with a specific revenue recognition code. Character limit: 32 Values: inherited from ProductRatePlanCharge.RevRecCode - `results.InvoiceDatas.InvoiceItem.RevRecStartDate` (string) The date when revenue recognition is triggered. Character limit: 29 Values: generated from InvoiceItem.RevRecTriggerCondition - `results.InvoiceDatas.InvoiceItem.RevRecTriggerCondition` (string) Specifies when revenue recognition begins based on a triggering event. Character limit: Values: inherited from ProductRatePlanCharge.RevRecTriggerCondition - `results.InvoiceDatas.InvoiceItem.SKU` (string) The unique SKU for the product associated with this invoice item. Character limit: 255 Values: inherited from Product.SKU - `results.InvoiceDatas.InvoiceItem.ServiceEndDate` (string) The end date of the service period associated with this invoice item. Service ends one second before the date in this value. Character limit: 29 Values: automatically generated - `results.InvoiceDatas.InvoiceItem.ServiceStartDate` (string) The start date of the service period associated with this invoice item. If the associated charge is a one-time fee, then this date is the date of that charge. Character limit: 29 Values: automatically generated - `results.InvoiceDatas.InvoiceItem.SubscriptionId` (string) The ID of the subscription associated with the invoice item. Character limit: 32 Values: inherited from Subscription.Id - `results.InvoiceDatas.InvoiceItem.SubscriptionNumber` (string) The number of the subscription associated with the invoice item. Character limit: Values: - `results.InvoiceDatas.InvoiceItem.TaxAmount` (number) The amount of tax applied to the invoice item's charge. Character limit: Values: calculated from multiple fields in the ProductRatePlanCharge object - `results.InvoiceDatas.InvoiceItem.TaxCode` (string) Specifies the tax code for taxation rules. Character limit: 6 Values: inherited from ProductRatePlanCharge.TaxCode - `results.InvoiceDatas.InvoiceItem.TaxExemptAmount` (number) The calculated tax amount excluded due to the exemption. Character limit: Values: calculated from multiple fields in the ProductRatePlanCharge object - `results.InvoiceDatas.InvoiceItem.TaxMode` (string) The tax mode of the invoice item. Character limit: 12 Values: TaxExclusive, TaxInclusive - `results.InvoiceDatas.InvoiceItem.UOM` (string) Specifies the units to measure usage. Units of measure are configured in the web-based UI: Z-Billing > Settings Character limit: Values: inherited from ProductRatePlanCharge.UOM - `results.InvoiceDatas.InvoiceItem.UnitPrice` (number) The per-unit price of the invoice item. Character limit: Values: calculated from multiple fields in ProductRatePlanCharge and ProductRatePlanChargeTier objets - `results.InvoiceDatas.InvoiceItem.UpdatedById` (string) The ID of the user who last updated the invoice item. Character limit: 32 Values: automatically generated - `results.InvoiceDatas.InvoiceItem.UpdatedDate` (string) The date when the invoice item was last updated. Character limit: 29 Values: automatically generated - `results.InvoiceId` (string) - `results.PaymentId` (string) - `results.PaymentTransactionNumber` (string) - `results.SubscriptionId` (string) - `results.Success` (boolean) - `results.TotalDeltaMrr` (number) TotalDeltaMrr is calculated by the following formula: TotalDeltaMrr = newSubscription.CMRR - originalSubscription.CMRR See [here](https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_How_to_Manage_Customer_Accounts/E_Key_Metrics/B_Monthly_Recurring_Revenue#Contracted_MRR) for the definition of CMRR. The new subscriptin represents the later version of an subscription after an amendment. The original subscription represents the original version of the subscription before the amendment. - `results.TotalDeltaTcv` (number) ## Response 401 fields (application/json): - `message` (string) Error message. If the error message is "Authentication error", ensure that the Authorization request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information. If the error message is "Failed to get user info", retry the request.