Subscription offers are what customers purchase to subscribe toa particular product or service. They contain pricing informationfor one or more products which are part of the offer.
NOTE: If hosted pages are used, the offer name anddescription are shown directly to your customers. Make sure theyare descriptive and explain the offer.
Methods
The following methods are available for offers:
Data Structures
Offer
| Field | Description | Required | Format |
|---|---|---|---|
| OfferCode |
Short alpha-numeric identifier for the offer. Must be uniqueamongst the set of configured offers. |
yes | up to 60 characters |
| Name | The name of the offer. | yes | up to 60 characters |
| Description | The detailed description for the offer. | no | up to 1024 characters |
| Status | The status of the offer: "Active" or "Inactive". | yes | enumeration |
Price Plan
| Field | Description | Required | Format |
|---|---|---|---|
| Currency Code | Code defining the currrency to be used for this price plan. Forexample, "USD" for US dollar. | yes | 3 characters |
| Free Trial Duration | The duration of the free trial either in days or months Seefree trial duration type below. | no | integer |
| Free Trial Type | The type of free trial, either "Day" or "Month". | no | enumeration |
| Price Plan Code | Short alpha-numeric identifier for the price plan. | yes | up to 60 characters |
Price Plan Item
| Field | Description | Required | Format |
|---|---|---|---|
| Amount | The amount associated with this price plan item. | yes | decimal |
| Price Plan Item Type Code | Identifier for the type of price plan item. Possible valuesare:
FA - Activation Fee
FC - Cancellation Fee FR - Recurring Fee FU - Usage Fee FUS - Simple Usage Fee |
yes | enumeration |
| Product Name | The name of the product with which the price plan item isassociated with. | no | up to 60 characters |
| Price Plan Code | Short alpha-numeric identifier for the price plan. | yes | up to 60 characters |