getSubscribers - Call Reference - Open eBay Subscription API

getSubscribers

Returns information about an application's subscribers. The application identity and token are sent in the HTTPS header.

getSubscribers Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getSubscribersResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <paginationOutput> PaginationOutput
    <entriesPerPage> int </entriesPerPage>
    <pageNumber> int </pageNumber>
    <totalEntries> int </totalEntries>
    <totalPages> int </totalPages>
  </paginationOutput>
  <subscriber> Subscriber
    <subscription> Subscription
      <billingStartDate> dateTime </billingStartDate>
      <externalPlanId> string </externalPlanId>
      <planId> long </planId>
      <property> SubscriptionPropertyCode </property>
      <!-- ... more property nodes here ... -->
      <reasonCode> SubscriptionReasonCode </reasonCode>
      <subscriptionCancelRequestTime> dateTime </subscriptionCancelRequestTime>
      <subscriptionEndTime> dateTime </subscriptionEndTime>
      <subscriptionId> long </subscriptionId>
      <subscriptionStartTime> dateTime </subscriptionStartTime>
      <subscriptionState> SubscriptionState </subscriptionState>
    </subscription>
    <subscriptionHistory> SubscriptionHistory
      <subscription> Subscription
        <billingStartDate> dateTime </billingStartDate>
        <externalPlanId> string </externalPlanId>
        <planId> long </planId>
        <property> SubscriptionPropertyCode </property>
        <!-- ... more property nodes here ... -->
        <reasonCode> SubscriptionReasonCode </reasonCode>
        <subscriptionCancelRequestTime> dateTime </subscriptionCancelRequestTime>
        <subscriptionEndTime> dateTime </subscriptionEndTime>
        <subscriptionId> long </subscriptionId>
        <subscriptionStartTime> dateTime </subscriptionStartTime>
        <subscriptionState> SubscriptionState </subscriptionState>
      </subscription>
      <!-- ... more subscription nodes here ... -->
    </subscriptionHistory>
    <userName> string </userName>
  </subscriber>
  <!-- ... more subscriber nodes here ... -->
  <subscriberCount> int </subscriberCount>
</getSubscribersResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

ack	AckValue	Always	Indicates whether or not errors or warnings were generated during the processing of the request. Applicable values: • Failure (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • PartialFailure (out) The request that triggered the error was processed successfully but with some warnings. • Success (out) The request was processed successfully, but something occurred that may affect your application or the user. • Warning (out) The request that triggered the error was processed successfully but with some warnings.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	ActivityProfile about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: • Application (out) An error occurred due to a problem with the request, such as missing or invalid fields. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. Once the problem in the appilcation or data is resolved, resend the corrected request to eBay. • Request (out) An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the data is resolved, resend the request to eBay with the corrected data. • System (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
errorMessage.error.domain	string	Conditionally	Name of the domain upon which the error occurred. Domains include: Marketplace A business or validation error occurred for the UserProfile Service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that resulted in the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	The name of the parameter in the list of parameter types returned within the error type.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Applicable values: • Error (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • Warning (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain upon which the error occurred. Subdomains include the following: UserProfile (in which the error is specific to the UserProfile service) and MarketplaceCommon (in which the error is common to all Marketplace services).
timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.
version	string	Always	The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. Note: The version in use is normally the latest release version, as specified in the release notes.

Call-specific Output Fields

paginationOutput	PaginationOutput	Always	The page number of the response data, the number of entries, etc.
paginationOutput .entriesPerPage	int	Always	The maximum number of entries that can be returned in the response. This number is always equal to the value that you specified for paginationInput.entriesPerPage. The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of entries found on the specified pageNumber. In this case, there will be fewer entries returned than the number specified in entriesPerPage.
paginationOutput.pageNumber	int	Always	The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of entries divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of item data. This returned value indicates the page number of data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire set of data. The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of data in the set of data, and the value for pageNumber is set to the respective (last) page number.
paginationOutput.totalEntries	int	Always	The total number of entries. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set.
paginationOutput.totalPages	int	Always	The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change.
subscriber	Subscriber	Conditionally, repeatable: [0..*]	Information about the subscriber and subscription history.
subscriber.subscription	Subscription	Conditionally	Details about the subscription.
subscriber.subscription .billingStartDate	dateTime	Conditionally	Start date of the user's term for purposes of billing.
subscriber.subscription .externalPlanId	string	Always	A developer-assigned Plan ID that will be passed in the externalID field of the addSubscriber call to notify you of a new subscription.
subscriber.subscription.planId	long	Always	Identifies the plan to which the user is subscribed.
subscriber.subscription .property	SubscriptionPropertyCode	Conditionally, repeatable: [0..*]	Information about a subscriber's eligibility for a free trial. Applicable values: • AuthTokenRevoked (out) The subscription is ineligible for a free trial because the user's token has been revoked. • NotEligibleForFreeTrial (out) The subscription is not eligible for a free trial, probably because the user has previously subscribed to a free trial.
subscriber.subscription .reasonCode	SubscriptionReasonCode	Conditionally	The reason for the subscription state. Applicable values: • AccountNotPaidInTime (out) Following the suspension of a past due subscription, if the account remains unpaid, eBay will put the subscription in the AccountNotPaidInTime state and cancel the the subscription. • AccountPastDue (out) User has been billed, and a payment failure has occurred. The subscription is still active. User will be suspended by eBay if the account balance is greater than one dollar and more than 18 days have elapsed since the last billing statement. eBay will cancel the subscription at 22 days after the last billing statement. • BillingPending (out) Subscription is pending on eBay internal billing processing. • CancelledByDeveloper (out) Account has been cancelled by developer. • CancelledByEbay (out) eBay has cancelled the subscription, possibly because the account remained unpaid for 22 days following a billing statement. • CancelledBySubscriber (out) User has cancelled the subscription. If this occurs during the free trial period, the subscription is cancelled immediately. If the user requests immediate cancellation from a paid subscription, see Cancel Immediately in the Managed Billing Platform Guide for steps you should take. • EPIPending (out) Subscription is pending an OEPI response. eBay has made the corresponding OEPI call to your application's listener but has not received a response, or has received a response with a Pending status. Or eBay has not yet made the OEPI call. • RejectedByDeveloper (out) Developer has declined to accept the subscription. • RejectedByEbay (out) eBay has declined to accept the subscription. • SuspendedByDeveloper (out) Developer has suspended the subscription. • SuspendedByEbay (out) eBay has suspended the subscription, possibly because of a payment failure and an account past due. User can not use the application until the subscription state returns to Active. After the user brings the account current, the subscription's transition back to the Active state takes about five minutes.
subscriber.subscription .subscriptionCancelRequestTime	dateTime	Conditionally	The date when the user submitted a cancel request
subscriber.subscription .subscriptionEndTime	dateTime	Conditionally	End date of the user's subscription. Specifically, the endDate is the date on which the subscription actually ends. That is, for a prorated-at-end plan, it is the date when the user unsubscribed. (For prorated-at-end plans, the cancel and end dates are the same.) For a nonprorated-at-end plan, it is the date of the term end.
subscriber.subscription .subscriptionId	long	Always	Identifies a user's subscription to a billing plan offered by an Open eBay app.
subscriber.subscription .subscriptionStartTime	dateTime	Always	The date when the user subscribed to the plan, e.g. the start of the free trial.
subscriber.subscription .subscriptionState	SubscriptionState	Always	Identifies the state of the subscription. Applicable values: • Active (in/out) The user is actively subscribed to the application. • Cancelled (in/out) User is no longer subscribed to the 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. • CancelledPending (in/out) 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. • Created (in/out) For internal use. • Expired (in/out) The user's free trial period has elapsed. • Pending (in/out) The subscription has been created and is not yet active. • Rejected (in/out) One of the following has occurred: your application rejected the subscription after receiving an addSubscriber call, or you have manually changed the subscription to the rejected state. • Suspended (in/out) Suspended state, possibly due to a payment failure or past due account. There is a block (which can be removed) on the user's access to the application. The user cannot start the application.
subscriber.subscriptionHistory	SubscriptionHistory	Conditionally	Details about the subscription history.
subscriber.subscriptionHistory .subscription	Subscription	Conditionally, repeatable: [0..*]	Information about one of the subscriptions in the subscriber's history with the application.
subscriber.subscriptionHistory .subscription.billingStartDate	dateTime	Conditionally	Start date of the user's term for purposes of billing.
subscriber.subscriptionHistory .subscription.externalPlanId	string	Always	A developer-assigned Plan ID that will be passed in the externalID field of the addSubscriber call to notify you of a new subscription.
subscriber.subscriptionHistory .subscription.planId	long	Always	Identifies the plan to which the user is subscribed.
subscriber.subscriptionHistory .subscription.property	SubscriptionPropertyCode	Conditionally, repeatable: [0..*]	Information about a subscriber's eligibility for a free trial. Applicable values: • AuthTokenRevoked (out) The subscription is ineligible for a free trial because the user's token has been revoked. • NotEligibleForFreeTrial (out) The subscription is not eligible for a free trial, probably because the user has previously subscribed to a free trial.
subscriber.subscriptionHistory .subscription.reasonCode	SubscriptionReasonCode	Conditionally	The reason for the subscription state. Applicable values: • AccountNotPaidInTime (out) Following the suspension of a past due subscription, if the account remains unpaid, eBay will put the subscription in the AccountNotPaidInTime state and cancel the the subscription. • AccountPastDue (out) User has been billed, and a payment failure has occurred. The subscription is still active. User will be suspended by eBay if the account balance is greater than one dollar and more than 18 days have elapsed since the last billing statement. eBay will cancel the subscription at 22 days after the last billing statement. • BillingPending (out) Subscription is pending on eBay internal billing processing. • CancelledByDeveloper (out) Account has been cancelled by developer. • CancelledByEbay (out) eBay has cancelled the subscription, possibly because the account remained unpaid for 22 days following a billing statement. • CancelledBySubscriber (out) User has cancelled the subscription. If this occurs during the free trial period, the subscription is cancelled immediately. If the user requests immediate cancellation from a paid subscription, see Cancel Immediately in the Managed Billing Platform Guide for steps you should take. • EPIPending (out) Subscription is pending an OEPI response. eBay has made the corresponding OEPI call to your application's listener but has not received a response, or has received a response with a Pending status. Or eBay has not yet made the OEPI call. • RejectedByDeveloper (out) Developer has declined to accept the subscription. • RejectedByEbay (out) eBay has declined to accept the subscription. • SuspendedByDeveloper (out) Developer has suspended the subscription. • SuspendedByEbay (out) eBay has suspended the subscription, possibly because of a payment failure and an account past due. User can not use the application until the subscription state returns to Active. After the user brings the account current, the subscription's transition back to the Active state takes about five minutes.
subscriber.subscriptionHistory .subscription .subscriptionCancelRequestTime	dateTime	Conditionally	The date when the user submitted a cancel request
subscriber.subscriptionHistory .subscription .subscriptionEndTime	dateTime	Conditionally	End date of the user's subscription. Specifically, the endDate is the date on which the subscription actually ends. That is, for a prorated-at-end plan, it is the date when the user unsubscribed. (For prorated-at-end plans, the cancel and end dates are the same.) For a nonprorated-at-end plan, it is the date of the term end.
subscriber.subscriptionHistory .subscription.subscriptionId	long	Always	Identifies a user's subscription to a billing plan offered by an Open eBay app.
subscriber.subscriptionHistory .subscription .subscriptionStartTime	dateTime	Always	The date when the user subscribed to the plan, e.g. the start of the free trial.
subscriber.subscriptionHistory .subscription .subscriptionState	SubscriptionState	Always	Identifies the state of the subscription. Applicable values: • Active (in/out) The user is actively subscribed to the application. • Cancelled (in/out) User is no longer subscribed to the 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. • CancelledPending (in/out) 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. • Created (in/out) For internal use. • Expired (in/out) The user's free trial period has elapsed. • Pending (in/out) The subscription has been created and is not yet active. • Rejected (in/out) One of the following has occurred: your application rejected the subscription after receiving an addSubscriber call, or you have manually changed the subscription to the rejected state. • Suspended (in/out) Suspended state, possibly due to a payment failure or past due account. There is a block (which can be removed) on the user's access to the application. The user cannot start the application.
subscriber.userName	string	Conditionally	The user ID of the eBay member.
subscriberCount	int	Conditionally	Not returned if the output selector is set to SubscriptionHistory.

getSubscribers Samples

New to making API calls? Please see Making an API Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Requests information about a subscriber, including the subscription history.

Description

A user name is specified, limiting the response to information about the specified subscriber. Additionally, the SubscriptionHistory output selector is specified, so the user's subscription history is returned.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<getSubscribersRequest xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
  <userName>SubscriberUsername</userName>
  <outputSelector>SubscriptionHistory</outputSelector>
</getSubscribersRequest>

Output

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<getSubscribersResponse xmlns:ms="http://www.ebay.com/marketplace/services" xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
  <ack>Success</ack>
  <version>1.0.0</version>
  <timestamp>2010-02-28T19:16:25.315Z</timestamp>
  <subscriber>
    <userName>SubscriberUsername</userName>
    <subscription>
      <subscriptionId>5000023310</subscriptionId>
      <planId>1337</planId>
      <externalPlanId>67</externalPlanId>
      <subscriptionState>Cancelled</subscriptionState>
      <subscriptionStartTime>2009-10-06T21:03:59.000Z</subscriptionStartTime>
    </subscription>
    <subscriptionHistory>
      <subscription>
        <subscriptionId>5000023310</subscriptionId>
        <planId>1337</planId>
        <externalPlanId>67</externalPlanId>
        <subscriptionState>Cancelled</subscriptionState>
        <reasonCode>CancelledBySubscriber</reasonCode>
        <subscriptionStartTime>2009-10-06T21:03:59.000Z</subscriptionStartTime>
        <subscriptionEndTime>2009-11-01T21:38:28.000Z</subscriptionEndTime>
      </subscription>
    </subscriptionHistory>
  </subscriber>
</getSubscribersResponse>

getSubscribers Change History

Version	Description
1.0.0 2010-03-01	(added) New call.

User-Contributed Notes

outputSelector	SubscriberOutputSelector	Optional	Specify a value of SubscriberCount in this field if you want to get a count of subscribers. Specify a value of SubscriptionHistory in this field if you want to get subscribers's history. If you specify a value of SubscriptionHistory, you must specify the user name(s) in the request. Applicable values: • SubscriberCount (in) Use this value if you want to get a count of subscribers. • SubscriptionHistory (in) Use this value if you want to get subscribers' history. If you specify a value of SubscriptionHistory, you must specify the user name(s) in the request.
paginationInput	PaginationInput	Optional	Controls the pagination of the result set.
paginationInput.entriesPerPage	int	Optional	Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned.
paginationInput.pageNumber	int	Optional	Specifies the number of the page of data to return in the current call.
subscriptionEndTimeRange	TimeRange	Optional	Specifies the end of a time range for filtering the subscribers to be returned.
subscriptionEndTimeRange .timeFrom	dateTime	Optional	Specifies the earliest (oldest) date to be used in a date range.
subscriptionEndTimeRange .timeTo	dateTime	Optional	Specifies the latest (most recent) date to be used in a date range.
subscriptionStartTimeRange	TimeRange	Optional	Specifies the start of a time range for filtering the subscribers to be returned.
subscriptionStartTimeRange .timeFrom	dateTime	Optional	Specifies the earliest (oldest) date to be used in a date range.
subscriptionStartTimeRange .timeTo	dateTime	Optional	Specifies the latest (most recent) date to be used in a date range.
subscriptionState	SubscriptionState	Optional	Specifies the subscription state of the subscribers to be returned. Applicable values: • Active (in/out) The user is actively subscribed to the application. • Cancelled (in/out) User is no longer subscribed to the 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. • CancelledPending (in/out) 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. • Created (in/out) For internal use. • Expired (in/out) The user's free trial period has elapsed. • Pending (in/out) The subscription has been created and is not yet active. • Rejected (in/out) One of the following has occurred: your application rejected the subscription after receiving an addSubscriber call, or you have manually changed the subscription to the rejected state. • Suspended (in/out) Suspended state, possibly due to a payment failure or past due account. There is a block (which can be removed) on the user's access to the application. The user cannot start the application.
userName	string	Optional	The eBay user ID of the subscriber. If the output selector is SubscriptionHistory, then this field is required.

Open eBay Subscription Call Reference Version 1.2.0

Open eBay Subscription
Call Reference Version 1.2.0