This object contains the information needed to create a new subscription for the account. It is part of the entire subscribe process. The subscribe call is a superset of Subscription.
A subscription is a person signing up for a product for a certain amount of time.
Each subscription can have one or more RatePlans.
The set of {Product, product rate plan(s), and product rate plan charge(s)} is a defined set of products a company sells (for example, a family plan with each member costing $10). The set of {a Subscription, rate plan(s), and rate plan charge(s)} is an instance of a Product, with actual quantities specified (five family members on a family plan, for example).
This object is used in the query call.
In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.
| Name | Required? | Type | Allowable Values | Description |
|---|---|---|---|---|
| AccountId | No for the subscribe call; Yes otherwise | zns: ID | A valid account ID | This is the identification number of a valid Account. |
| AutoRenew | Yes | boolean | Yes or No (1 or 0) | Determines whether the subscription will be automatically renewed, or whether it will expire and need to be manually renewed at the end of the term. |
| CancelledDate | No | dateTime | A valid dateTime value | The date on which the contract was cancelled. This is read only, since it is automatically generated. |
| ContractAcceptanceDate | Yes if Status is set to Active; No otherwise | dateTime | A valid dateTime value | This is the date on which the contract was accepted by the customer. This must be more recent than the ServiceActivationDate. |
| ContractEffectiveDate | Yes | dateTime | A valid dateTime value | This is the date on which the contract becomes effective. |
| Currency | Yes | string | Any valid currency values | Specifies the currency in which the account is being paid. |
| InitialTerm | Yes | int | Any valid number | This provides the initial term for the subscription in months. If it isn't specified, it is set to 0. |
| Name | Yes | string | 50 characters | The name of the subscription. If you do not provide this, Zuora will automatically generate one for you. |
| Notes | No | string (textarea) | 500 characters | A field to use to record notes relating to the subscription. |
| OriginalSubscriptionId | No | string | This number is automatically generated | The ID for the very first subscription created for this customer. Since subscriptions are renewed, you can think of subscription IDs as a “chain” of subscriptions that connect from the first subscription to the current one. Although it is automatically generated, this field can be queried. |
| PreviousSubscriptionId | No | string | This number is automatically generated | The subscription ID immediately prior to the current one. Although it is automatically generated, this field can be queried. |
| RenewalTerm | Yes | int | Any valid number | This provides the renewal term for the subscription in months—the number of months for which you want to renew the subscription. If it isn't specified, it is set to 0. |
| ServiceActivationDate | Yes if Status is set to PendingAcceptance; No otherwise | dateTime | A valid dateTime value | This is when the service was activated. This is must be more recent than the ContractEffectiveDate. |
| Status | Yes | string (enum) | Draft, PendingActivation, PendingAcceptance, Active, Cancelled | A list of values reflecting the status of the subscription. |
| TermStartDate | Yes | dateTime | A valid dateTime value | This is when the subscription term starts. |
| Version | Yes | int | This is a read-only field | This is the version of the subscription (first version, second version, etc.). |
Copyright © 2008-2009 Zuora, Inc.