GET/subscription
This method retrieves a list of subscriptions associated with the seller account.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| limit | string | This field is for future use. Occurrence: Optional |
| continuation_token | string | This field is for future use. Occurrence: Optional |
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.
OAuth scope
This request requires an access token created with the authorization code grant flow, 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):
https://api.ebay.com/oauth/api_scope/sell.account
https://api.ebay.com/oauth/api_scope/sell.account.readonly
eBayUser
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| href | string | This field is for future use. Occurrence: Conditional |
| limit | integer | This field is for future use. Occurrence: Conditional |
| next | string | This field is for future use. Occurrence: Conditional |
| subscriptions | array of Subscription | An array of subscriptions associated with the seller account. Occurrence: Always |
| subscriptions.marketplaceId | MarketplaceIdEnum | The marketplace with which the subscription is associated. Occurrence: Required |
| subscriptions.subscriptionId | string | The subscription ID. Occurrence: Required |
| subscriptions.subscriptionLevel | string | The subscription level. For example, subscription levels for an eBay store include Starter, Basic, Featured, Anchor, and Enterprise levels. Occurrence: Required |
| subscriptions.subscriptionType | SubscriptionTypeEnum | The kind of entity with which the subscription is associated, such as an eBay store. Occurrence: Required |
| subscriptions.term | TimeDuration | The term of the subscription plan (typically in months). Occurrence: Required |
| subscriptions.term.unit | TimeDurationUnitEnum | These enum values represent the time measurement unit, such as Occurrence: Conditional |
| subscriptions.term.value | integer | An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field. Occurrence: Conditional |
| total | integer | The total number of subscriptions displayed on the current page of results. Occurrence: Always |
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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 20400 | API_ACCOUNT | REQUEST | Invalid request |
| 20403 | API_ACCOUNT | REQUEST | Invalid {fieldName}. {additionalInfo} |
| 20500 | API_ACCOUNT | APPLICATION | System error. |
Warnings
This call has no warnings.
Samples
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 all Subscriptions
This method returns all subscriptions for the seller account.
Input
This method does not use a request payload.
GEThttps://api.ebay.com/sell/account/v1/subscription
Output
If the call is successful, an array of all subscriptions associated with the seller account is returned.