A customer subscription is created when a customer subscribes toan offer or a promotion associated with an offer. A customer mayhave multiple active subscriptions. Each subscription contains alist of subscription items. Subscription items specify the productor service being subscribed to and provide the ability to configurethe product or service for a particular customer.
Methods
The following methods are available:
- Get Subscription
- Update Subscription
- Update Subscription Status
- Get Customer Subscriptions
- Create Customer Subscription
Data Structures
Subscription
| Field | Description | Required | Format |
|---|---|---|---|
| OfferCode | Short alpha-numeric identifier for the offer associated withthis subscription. | required, unless promotion code is supplied | up to 60 characters |
| PromotionCode | Short alpha-numeric identifier for the promotion associatedwith this subscription. | up to 60 characters | |
| ResellerID | Short alpha-numeric identifier for the reseller associated withthis subscription. | up to 60 characters | |
| Status | The status of the subscription, one of the following: "Active","Suspended", "Closed", or "Inactive". | yes | enumeration |
| SubscriptionID | Numeric identifier for the subscription. | yes | numeric |
| SubscriptionItems | Array of subscription items. | yes | SubscriptionItem structure |
Subscription Item
A subscription item describes a particular product or servicethat is part of the subscription.
| Field | Description | Required | Format |
|---|---|---|---|
| Fields | Array of subscription item fields. | SubscriptionItemFieldstructure | |
| ProductCode | Short alpha-numeric identifier for the product or service beingconfigured as part of this subscription. | yes | up to 60 characters |
| SubscriptionItemID | Short alpha-numeric identifier for the subscription item. | yes | up to 60 characters |
Subscription Item Field
A subscription item field contains data used to configure orprovision a particular product or service as part of thesubscription.
| Field | Description | Required | Format |
|---|---|---|---|
| ProductFieldCode | Short alpha-numeric identifier for the associated customproduct field. | yes | up to 60 characters |
| Value | Value for the custom product field in this subscriptionitem. | format depends on configuration of product field. one of:string, numeric, enumeration, or date |