action api_get_subscription {
label: "getSubscription"
description: "This method retrieves a list of subscriptions associated with the seller account."
provider: api
method: GET
path: "/subscription"
encoding: json
input: {
type: "object"
properties: {
continuation_token: {
type: "string"
}
limit: {
type: "string"
}
}
additionalProperties: false
}
output: {
type: "object"
description: "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 pagination-related fields are for future use."
properties: {
href: {
type: "string"
description: "This field is for future use."
}
limit: {
type: "integer"
format: "int32"
description: "This field is for future use."
}
next: {
type: "string"
description: "This field is for future use."
}
subscriptions: {
type: "array"
description: "An array of subscriptions associated with the seller account."
items: {
type: "object"
description: "This type is used by the getSubscription response container, which defines the subscription types and levels for the seller account."
properties: {
marketplaceId: {
type: "string"
description: "The marketplace with which the subscription is associated. For implementation help, refer to eBay API documentation"
}
subscriptionId: {
type: "string"
description: "The subscription ID."
}
subscriptionLevel: {
type: "string"
description: "The subscription level. For example, subscription levels for an eBay store include Starter, Basic, Featured, Anchor, and Enterprise levels."
}
subscriptionType: {
type: "string"
description: "The kind of entity with which the subscription is associated, such as an eBay store. For implementation help, refer to eBay API documentation"
}
term: {
type: "object"
description: "The term of the subscription plan (typically in months)."
properties: {
unit: {
type: "string"
description: "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. For implementation help, refer to eBay API documentation"
}
value: {
type: "integer"
format: "int32"
description: "An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field."
}
}
}
}
}
}
total: {
type: "integer"
format: "int32"
description: "The total number of subscriptions displayed on the current page of results."
}
}
}
}