Skip to main content

GET/subscription

This method retrieves a list of subscriptions associated with the seller account.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/subscription?

URI parameters

ParameterTypeDescription
limitstringThis field is for future use.

Occurrence: Optional

continuation_tokenstringThis 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/fieldTypeDescription
hrefstring

This field is for future use.

Occurrence: Conditional

limitinteger

This field is for future use.

Occurrence: Conditional

nextstring

This field is for future use.

Occurrence: Conditional

subscriptionsarray of Subscription

An array of subscriptions associated with the seller account.

Occurrence: Always

subscriptions.marketplaceIdMarketplaceIdEnum

The marketplace with which the subscription is associated.

Occurrence: Required

subscriptions.subscriptionIdstring

The subscription ID.

Occurrence: Required

subscriptions.subscriptionLevelstring

The subscription level. For example, subscription levels for an eBay store include Starter, Basic, Featured, Anchor, and Enterprise levels.

Occurrence: Required

subscriptions.subscriptionTypeSubscriptionTypeEnum

The kind of entity with which the subscription is associated, such as an eBay store.

Occurrence: Required

subscriptions.termTimeDuration

The term of the subscription plan (typically in months).

Occurrence: Required

subscriptions.term.unitTimeDurationUnitEnum

These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.

See TimeDurationUnitEnum for a complete list of possible time-measurement units.

Occurrence: Conditional

subscriptions.term.valueinteger

An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.

Occurrence: Conditional

totalinteger

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.

StatusMeaning
200Success
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
20400API_ACCOUNTREQUESTInvalid request
20403API_ACCOUNTREQUESTInvalid {fieldName}. {additionalInfo}
20500API_ACCOUNTAPPLICATIONSystem 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.