This method allows applications to retrieve subscription details for the specified subscription.
Specify the subscription to retrieve using the subscription_id. Use the getSubscriptions method to browse all subscriptions if you do not know the subscription_id.
Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business.
This method is not supported in Sandbox environment.
HTTP request headers
All requests made to eBay REST operations require you to provide the
Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
This request requires an access token created with either authorization code grant flow or client credentials grant flow. Please refer to the note below for more details.
The access token must be created using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
Note: An OAuth token created with the client credentials grant flow and the https://api.ebay.com/oauth/api_scope scope is required in order to create, update, or retrieve application-based subscriptions to notification topics. An OAuth token created with the authorization code grant flow and the https://api.ebay.com/oauth/api_scope/commerce.notification.subscription scope is required in order to create, update, or retrieve user-based subscriptions to notification topics.
This call has no payload.
This call has no field definitions.
HTTP response headers
This call has no response headers.
The unique identifier for the subscription.
The unique identifier for the topic associated with this subscription.
The status of this subscription.
The creation date for this subscription.
The payload associated with this subscription.
The supported format.
The supported schema version.
The supported protocol. For example:
The unique identifier for the destination associated with this subscription.
The unique identifier for the filter associated with this subscription.
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|195000||API_NOTIFICATION||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|195013||API_NOTIFICATION||REQUEST||The subscription id does not exist.|
This call has no warnings.
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get subscription
This method allows applications or users to retrieve subscription details and status for the specified subscription (and application).
Ths input specifies the subscription_id.
The output is a subscription and its details such as the subscriptionId, topicId, status, creationDate, payload, destinationId, and filterId.