getSubscriptions

Returns information about subscriptions of the specified notification type. You can use this API to retrieve all subscriptions when multiple subscriptions exist for a notification type (for example, when using filter expressions).

The operation returns all subscriptions for the caller's party.

payloadVersion is an optional parameter. When you do not provide payloadVersion, the operation returns subscriptions across all payload versions.

Usage Plan:

Rate (requests per second)Burst
15

The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Query Params
notificationTypes
array of strings
required
length between 1 and 1

A list of notification types to retrieve subscriptions for. Currently limited to a single notification type per request.

For more information about notification types, refer to the Notifications API v1 Use Case Guide.

notificationTypes*
string

The version of the payload object to be used in the notification.

integer
30 to 100
Defaults to 30

The maximum number of subscriptions to return per page. Minimum value is 30. Maximum value is 100. Default is 30.

string

A token to retrieve the next page of results. If this field is not empty in a response, pass its value in the next request to retrieve the next page.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json