How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eBay Subscription API

The Subscription API from eBay — 7 operation(s) for subscription.

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 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.ebay.com{basePath}.

11 operations 7 paths 10 schemas 2 DELETE3 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.ebay.com
Authentication
OAuth 2.0
Contact
eBay Inc,
Resource Areas
1

Authentication & Security 1

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.
getSubscription 2 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…
createSubscription 1 param body → 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…
createSubscriptionFilter 2 params body → 201400403404500
GET
/subscription/{subscription_id}
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…
getSubscription 1 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…
updateSubscription 2 params body → 204400404409500
DELETE
/subscription/{subscription_id}
This method allows applications to delete a subscription. Subscriptions can be deleted regardless of status.
deleteSubscription 1 param → 204400404500
GET
/subscription/{subscription_id}/filter/{filter_id}
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…
getSubscriptionFilter 2 params → 200400403404500
DELETE
/subscription/{subscription_id}/filter/{filter_id}
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…
deleteSubscriptionFilter 2 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 .
disableSubscription 1 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 .
enableSubscription 1 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…
testSubscription 1 param → 202400404500

Schemas 10

The contract defines 10 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.

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
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
UpdateSubscriptionRequest
object
A type that describes the details of the update subscription request.
3 properties
SubscriptionSearchResponse
object
A type that describes the details of the subscription search response.
5 properties
CreateSubscriptionFilterRequest
object
1 property
SubscriptionPayloadDetail
object
A type that describes the details of the subscription payload.
3 properties
Subscription_2
object
A type that describes the subscription.
7 properties
CreateSubscriptionRequest
object
This type contains information about a subscription request.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-subscription-api-openapi.yml Raw ↑

Other APIs eBay publishes across the network.

eBay Advertising_eligibility API
eBay Bidding API
eBay Category_tree API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Custom_policy API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API
Where this information came from

This is an independent, third-party profile of eBay Subscription API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.