OpeneBaySubscriptionStateType ( string )
The subscription state of an eBay user.

Types that use OpeneBaySubscriptionStateType:

Enumeration Values
Value Description Which calls use this value *
Active Active state, i.e. actively subscribed to an application. addSubscriber, changeSubscriptionPlan, removeSubscriber, updateSubscriber, updateSubscriberCredentials
Cancelled Cancelled state, i.e. unsubscribed from an application. When a user clicks the "unsubscribe" link to unsubscribe from your non-prorated plan, eBay sends an updateSubscriber call to your application with the the subscription end date in the note field. The subscriptionStateChangeInfo.newState field may still be Active, but the user's status in in your Active Subscribers list will be CancelledPending. If you want to cancel the user's subscription immediately, use the control in the embedded applications tab in your My Account page as follows. In the embedded applications tab, select Active Users, and search for the user. Pull down the Status selection list, select Cancel Immediately, and then click Submit. addSubscriber, changeSubscriptionPlan, removeSubscriber, updateSubscriber, updateSubscriberCredentials
CancelledPending When a user clicks the "unsubscribe" link to unsubscribe from your non-prorated plan, eBay sends an updateSubscriber call to your application with the the subscription end date in the note field. The subscriptionStateChangeInfo.newState field may still be Active, but the user's status in in your Active Subscribers list will be CancelledPending. If you want to cancel the user's subscription immediately, use the control in the embedded applications tab in your My Account page as follows. In the embedded applications tab, select Active Users, and search for the user. Pull down the Status selection list, select Cancel Immediately, and then click Submit. addSubscriber, removeSubscriber, updateSubscriber, updateSubscriberCredentials
Created Reserved for future use. addSubscriber, removeSubscriber, updateSubscriber, updateSubscriberCredentials
Expired Expired state. addSubscriber, changeSubscriptionPlan, removeSubscriber, updateSubscriber, updateSubscriberCredentials
Pending Pending state. The subscription is not yet in the Active state. addSubscriber, changeSubscriptionPlan, removeSubscriber, updateSubscriber, updateSubscriberCredentials
Rejected Rejected state. One of the following has occurred: your application rejected the subscription (after receiving an addSubscriber call), or the subscription was manually changed (by the third-party application developer) to the rejected state. addSubscriber, changeSubscriptionPlan, removeSubscriber, updateSubscriber, updateSubscriberCredentials
Suspended Suspended state, e.g. due to a payment failure or past due account. There is a block (that can be removed) on the user's access to the application. That is, the user cannot start the application. addSubscriber, removeSubscriber, updateSubscriber, updateSubscriberCredentials
  * See the Enumeration Index to see exact use of each enumeration value in the API.

© 2009–2010 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.