eBay Subscription API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
11 operations
across 7 paths,
and defines 9 schemas.
It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
11 operations7 paths9 schemas2 DELETE3 GET5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
eBay Subscription API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth — The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 11
Across 7 paths, the API surfaces 11 operations — 2 DELETE, 3 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Subscription 11
GET
/subscription
This method retrieves a list of subscriptions associated with the seller account.
getSubscription2 params→ 200400500
POST
/subscription
This method allows applications to create a subscription for a topic and supported schema version. Subscriptions allow applications to express interest in notifications and keep receiving the informa…
createSubscription1 parambody→ 201400403409500
POST
/subscription/{subscription_id}/filter
This method allows applications to create a filter for a subscription. Filters allow applications to only be sent notifications that match a provided criteria. Notifications that do not match this cr…
This method allows applications to retrieve subscription details for the specified subscription. Specify the subscription to retrieve using the subscriptionid . Use the getSubscriptions method to bro…
getSubscription1 param→ 200400404500
PUT
/subscription/{subscription_id}
This method allows applications to update a subscription. Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business. Note: Th…
updateSubscription2 paramsbody→ 204400404409500
DELETE
/subscription/{subscription_id}
This method allows applications to delete a subscription. Subscriptions can be deleted regardless of status.
This method allows applications to retrieve the filter details for the specified subscription filter. Specify the subscription filter to retrieve by using the subscriptionid and the filterid associat…
This method allows applications to disable the active filter on a subscription, so that a new subscription filter may be added. Note: Subscription filters in PENDING status can not be disabled. Howev…
deleteSubscriptionFilter2 params→ 204400403404500
POST
/subscription/{subscription_id}/disable
This method disables a subscription, which prevents the subscription from providing notifications. To restart a subscription, call enableSubscription .
disableSubscription1 param→ 204400404500
POST
/subscription/{subscription_id}/enable
This method allows applications to enable a disabled subscription. To pause (or disable) an enabled subscription, call disableSubscription .
enableSubscription1 param→ 204400404409500
POST
/subscription/{subscription_id}/test
This method triggers a mocked test payload that includes a notification ID, publish date, and so on. Use this method to test your subscription end-to-end. You can create the subscription in disabled…
testSubscription1 param→ 202400404500
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Subscription_2 (7 properties), SubscriptionResponse (5 properties), SubscriptionFilter (5 properties), Subscription (5 properties). Each schema is shown below with its type and property counts.
TimeDuration
object
A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specif…
2 properties
SubscriptionFilter
object
5 properties
Subscription_2
object
A type that describes the subscription.
7 properties
SubscriptionResponse
object
This type is used by the response payload for the getSubscription method. Note : Pagination has not yet been enabled for getSubscription , so all of the pagina…
5 properties
Subscription
object
This type is used by the getSubscription response container, which defines the subscription types and levels for the seller account.
5 properties
CreateSubscriptionFilterRequest
object
1 property
CreateSubscriptionRequest
object
This type contains information about a subscription request.
4 properties
SubscriptionPayloadDetail
object
A type that describes the details of the subscription payload.
3 properties
UpdateSubscriptionRequest
object
A type that describes the details of the update subscription request.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
