Skip to navigation
Orders and SubscriptionsSubscriptions

Create a subscription

View as Markdown

This operation describes how to create a new subscription for an existing customer account.

Notes

If you have the Invoice Settlement feature enabled, it is best practice to set

the Zuora-Version parameter to 211.0 or later available versions.

Otherwise, an error occurs.

Default values for customerAcceptanceDate and serviceActivationDate are

set as follows. This API operation does not support creating a pending subscription.

serviceActivationDate(SA) specifiedserviceActivationDate (SA) NOT specified
customerAcceptanceDate (CA) specifiedSA uses value in the request call; CA uses value in the request callCA uses value in the request call;SA uses CE as default
customerAcceptanceDate (CA) NOT specifiedSA uses value in the request call; CA uses SA as defaultSA and CA use CE as default

This call supports a subset of the functionality of our Create an order call. We recommend using “Create an order” instead of this call because the Orders call has the following advantages:

  • Provides options for managing the entire subscription lifecycle from creation through to cancellation using different order actions.
  • Allows the creation or modifying of multiple subscriptions in a single order.
  • Allows a single order to combine both recurring subscription digital goods or services with order line items for physical goods.
  • Orders are treated as atomic transactions. If any part fails, the entire order and subscription changes are rolled back.

This call can be used to create a single subscription and there are no deprecation plans for this call. We will continue to support this call.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Idempotency-KeystringOptional<=255 characters
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-EncodingstringOptional

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-EncodingstringOptional

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

Zuora-Track-IdstringOptional<=64 characters

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

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

Zuora-Entity-IdsstringOptional

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

Zuora-Org-IdsstringOptional

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

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

Zuora-VersionstringOptional

The minor API version.

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

Request

This endpoint expects an object.
accountKeystringRequired
Customer account number or ID
contractEffectiveDatedateRequired

Effective contract date for this subscription, as yyyy-mm-dd

renewalTermlongRequired

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

subscribeToRatePlanslist of objectsRequired
Container for one or more rate plans for this subscription.
termTypestringRequired

Possible values are: TERMED, EVERGREEN.

applicationOrderlist of stringsOptional

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

Note:

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

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 Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

applyCreditBalancebooleanOptional

Whether to automatically apply a credit balance to an invoice.

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

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

Prerequisite: invoice must be true.

Note:

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

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

This field is only required if the termType field is set to TERMED.

collectbooleanOptionalDefaults to true

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

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

Prerequisite: The invoice or runBilling field must be true.

Note: This field is available only if you are on the latest Zuora API minor version, or you set the Zuora-Version request header to 196.0 or a later available version.

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

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

Default value is dependent on the value of other fields. See Notes section for more details.

documentDatedateOptional

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

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

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.

Allowed values:
gatewayIdstringOptional

The ID of the payment gateway instance. For example, 2c92c0f86078c4d5016091674bcc3e92.

If Payment Gateway Routing is enabled:

  • If this field is not specified, gateway routing rules will be invoked.
  • If this field is specified, the specified gateway will be used to process the payment.

If Payment Gateway Routing is disabled:

  • If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant.
  • If this field is specified, the specified gateway will be used to process the payment.
initialTermlongOptional

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

initialTermPeriodTypestringOptional

The period type for the first subscription term.

This field is used with the InitialTerm field to specify the initial subscription term.

Values are:

  • Month (default)
  • Year
  • Day
  • Week
invoiceOwnerAccountKeystringOptional

Invoice owner account number or ID.

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

invoiceSeparatelybooleanOptional

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

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

The default value is false.

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

lastBookingDatedateOptional

The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value today is set per the user’s timezone. The value of this field is as follows:

  • For a new subscription created by the Subscribe and Amend APIs, this field has the value of the subscription creation date.
  • For a subscription changed by an amendment, this field has the value of the amendment booking date.
  • For a subscription created or changed by an order, this field has the value of the order date.
notesstringOptional<=1000 characters
The notes for the subscription.
paymentMethodIdstringOptional
The ID of the payment method used for the payment.
prepaymentbooleanOptional

Indicates whether the subscription will consume the reserved payment amount of the customer account. See Prepaid Cash with Drawdown for more information.

renewalSettingstringOptional

Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.

Values:

  • RENEW_WITH_SPECIFIC_TERM (default)
  • RENEW_TO_EVERGREEN
renewalTermPeriodTypestringOptional

The period type for the subscription renewal term.

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

Values are:

  • Month (default)
  • Year
  • Day
  • Week
runBillingbooleanOptionalDefaults to true

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

The billing documents generated in this operation is only for this subscription, not for the entire customer account. Note: This field is available only if you are on the latest Zuora API minor version, or you set the Zuora-Version request header to 211.0 or a later available version.

Possible values:

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

  • false: No invoice is created.

serviceActivationDatedateOptional

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

Default value is dependent on the value of other fields. See Notes section for more details.

subscriptionNumberstringOptional

Subscription Number. The value can be up to 1000 characters.

If you do not specify a subscription number when creating a subscription, Zuora will generate a subscription number automatically.

If the account is created successfully, the subscription number is returned in the subscriptionNumber response field.

targetDatedateOptional

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

Note: - This field is available only if you are on the latest Zuora API minor version, or you set the Zuora-Version request header to 211.0 or a later available version.

  • The credit memo is only available if you have the Invoice Settlement feature enabled.
termStartDatedateOptional

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

CpqBundleJsonId__QTstringOptional<=32 characters
The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.
OpportunityCloseDate__QTdateOptional
The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
OpportunityName__QTstringOptional<=100 characters
The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
QuoteBusinessType__QTstringOptional<=32 characters
The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
QuoteNumber__QTstringOptional<=32 characters
The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
QuoteType__QTstringOptional<=32 characters
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.
IntegrationId__NSstringOptional<=255 characters

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

IntegrationStatus__NSstringOptional<=255 characters

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

Project__NSstringOptional<=255 characters

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

SalesOrder__NSstringOptional<=255 characters

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

SyncDate__NSstringOptional<=255 characters

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

Response headers

Content-EncodingstringOptional

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/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

OK
contractedMrrdoubleOptional
Monthly recurring revenue of the subscription.
creditMemoIdstringOptional

The credit memo ID, if a credit memo is generated during the subscription process.

Note: This container is only available if you set the Zuora REST API minor version to 207.0 or later available versions in the request header, and you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

invoiceIdstringOptional
Invoice ID, if an invoice is generated during the subscription process.
paidAmountdoubleOptional
Payment amount, if a payment is collected.
paymentIdstringOptional
Payment ID, if a payment is collected.
subscriptionIdstringOptional
subscriptionNumberstringOptional
successbooleanOptional

Returns true if the request was processed successfully.

totalContractedValuedoubleOptional
Total contracted value of the subscription.

Errors

4XX
Client Request Error
500
Internal Server Error