GET
/v1/subscription_itemsList subscription items
Lists the subscription items associated with a subscription. Provide subscription to scope the results, and use cursor parameters to navigate through multiple pages. The response includes each subscription item and a has_more indicator.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
ending_beforestringoptional
An object ID cursor used to retrieve the previous page of subscription items.
expandarray<string>optional
Fields to expand in the response; each value may contain at most 5,000 characters.
limitintegeroptional
The number of subscription items to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor used to retrieve the next page of subscription items.
subscriptionstringrequired
The unique identifier of the subscription whose items to retrieve, limited to 5,000 characters.
200Returns a list object containing subscription items, a `has_more` indicator, the list object type, and the list URL.
dataarray<SubscriptionItem>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultReturns an error object containing details about the failed subscription item list request.
errorobjectrequired
Error handling
subscription must identify the subscription whose items you want to retrieve. limit must be between 1 and 100 and defaults to 10 when omitted; use starting_after or ending_before with an object ID to paginate the results.