- CRUD: Update a subscription
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:
{
"message": "Error - unrecognised fields"
}By default, Zuora ignores unknown fields in the request body.
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.
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.
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 (').
This field can be updated when Status is Draft. Indicates if the subscription automatically renews at the end of the term. Values: true, false
The date of the Amendment object. Values: inherited from Amendment.EffectiveDate
The date when the customer accepts the contract.
This field can be updated when Status is Pending Acceptance.
Note : This field is only required in the Subscribe call if the Require Customer Acceptance of Orders? setting is set to Yes. If this setting is set to Yes:
- If the
ServiceActivationDatefield is required, you must set this field,ServiceActivationDate, andContractEffectiveDatefields in the Subscribe call to activate a subscription. - If the
ServiceActivationDatefield is not required, you must set both this field and theContractEffectiveDatefield in the Subscribe call to activate a subscription. If you only set a valid date in theContractEffectiveDatefield, the Subscribe call still returns success, but the subscription is inPending Acceptancestatus.
This field can also be updated when the subscription is still on version one (has not been amended before) and the Allow update Subscription trigger dates? setting in Billing Settings is set to Yes.
The date when the contract takes effect.
This field can be updated when Status is Draft.
Note: This field is required in the Subscribe call. If you set the value of this field to null and both the ServiceActivationDate and ContractAcceptanceDate fields are not required, the Subscribe call still returns success, but the new subscription is in DRAFT status. To activate the subscription, you must set a valid date to this field.
This field can also be updated when the subscription is still on version one (has not been amended before) and the Allow update Subscription trigger dates? setting in Billing Settings is set to "Yes".
The period type for the current subscription term. This field is used with the CurrentTerm field to specify the current subscription term. Values:
Month(default)YearDayWeek
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.
The length of the period for the first subscription term. This field can be updated when Status is Draft. Required: If TermType is Termed Character limit: 20 Values: any valid number.
The period type for the first subscription term. Values:
Month(default)YearDayWeekNote:This field can be updated when Status is
Draft.This field is used with the InitialTerm field to specify the initial subscription term.
Determines if the subscription is invoiced separately. If TRUE, then all charges for this subscription are collected into the subscription's own invoice. Values: TRUE, FALSE (default)
The unique identifier of the subscription. If you don't specify a value, then Zuora generates a name automatically. Whether auto-generated or manually specified, the subscription name must be unique. Otherwise an error will occur. Character limit: 100 Values: one of the following:
- leave null to automatically generate
- a string of 100 characters or fewer
Use this field to record comments about the subscription. Character limit: 500 Values: a string of 500 characters or fewer
This field can be updated when Status is Draft. Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed. Required: If TermType is Termed Values: RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN
The length of the period for the subscription renewal term. This field can be updated when Status is Draft. Required: If TermType is Termed. Character limit: 20 Values: one of the following:
- leave null to default to
0 - any number
The period type for the subscription renewal term. Values:
Month(default)YearDayWeekNote:This field is used with the RenewalTerm field to specify the subscription renewal term.
This field can be updated when Status is
Draft.
The date when the subscription is activated.
Character limit: 29
This field can be updated when Status is Pending Activation.
Note: This field is only required in the Subscribe call if the Require Service Activation of Orders? setting is set to Yes. If this setting is set to Yes:
- If the
ContractAcceptanceDatefield is required, you must set this field,ContractAcceptanceDate, andContractEffectiveDatefields in the Subscribe call to activate a subscription. - If the
ContractAcceptanceDatefield is not required, you must set both this field and theContractEffectiveDatefield in the Subscribe call to activate a subscription. If you only set a valid date in theContractEffectiveDatefield, the Subscribe call still returns success, but the subscription is inPending Activationstatus.
This field can also be updated when the subscription is still on version one (has not been amended before) and the Allow update Subscription trigger dates? setting in Billing Settings is set to "Yes".
The status of the subscription. Character limit: 18 Values: automatically generated Possible values: one of the following:
DraftPending ActivationPending AcceptanceActiveCancelledExpiredSuspended(This value is in Limited Availability.)
This field can be updated when Status is Draft. The date when the subscription term begins. If this is a renewal subscription, then this date is different from the subscription start date. Character limit: 29 Version notes: --
This field can be updated when Status is Draft. Indicates if a subscription is termed or evergreen. Character limit: 9 Values: TERMED, EVERGREEN
The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.
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.
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.
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 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 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.
ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Status of the subscription's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
The NetSuite project that the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite.
The NetSuite sales order than the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite.
Date when the subscription was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Custom fields of the Subscription object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.
- https://rest.zuora.comhttps://rest.zuora.com/v1/object/subscription/{id}
{ "IsInvoiceSeparate": true }
This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
application/jsonapplication/xmltext/htmltext/csvtext/plain
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
{ "Success": true, "Id": "2c93808457d787030157e02ea04123cf" }