List subscriptions
List subscriptions
Overview
List subscriptions
Request parameters
cursorstringquery
Opaque cursor from the previous response. Omit for the first page.
limitnumberquery
Items per page. Default: 50. Maximum: 200.
subscriberstringquery
Filter by subscriber ID.
countrystringquery
Filter by subscription country code.
sourcestringquery
Filter by order source ID.
is_giftbooleanquery
Filter by gift status. Use true for gift subscriptions, false for non-gifts.
searchstringquery
Partial text search across subscription and subscriber fields.
Request body
No request body.
Request examples
No request body.
Responses
has_morebooleanRequiredTrue if more items are available after this page.
cursorstringRequiredPass this as cursor to fetch the next page. Null when has_more is false.
itemsSubscription[]RequiredArray (Subscription):
idstringSubscription ID.
statusSubscriptionStatusvalues
- Active
- Active - Renewals stopped
- Complete
- Cancelled
- Past due
mediumPrint | Digital | Print + digitalfirst_namestringlast_namestringshipping_addressShippingAddressObject (ShippingAddress):
companystringaddress1stringaddress2stringcitystringstatestringpostcodestringcountrystringcountry_namestringphonestringlengthnumberHow many issues have been purchased during the subscription.
notesstringOptional internalnotes about the subscription.
is_recurringbooleanis_compbooleanTrue if the subscription is a complimentary subscription (no purchase made).
is_giftbooleangifterGifterRefDetails of the person who gifted the subscription (when is_gift is true).
Object (GifterRef):
full_namestringemailstringpromo_codestringdiscount_amountstringrefundedstringcurrencystringpricestringorder_datedatestart_issueIssueRefObject (IssueRef):
idstringnumbernumbernamestringissue_listnumber[]Issue numbers included in this subscription.
periodsSubscriptionPeriod[]Array (SubscriptionPeriod):
idnumberorder_datedateis_completebooleanlengthnumberHow many issues this period contains.
issue_listnumber[]Issue numbers included in this period.
subscriberSubscriberRefObject (SubscriberRef):
idstringfull_namestringemailstringsourceSourceRefObject (SourceRef):
idstringnamestringExample
{
"has_more": "<boolean>",
"cursor": "<string>",
"items": [
{
"id": "<string>",
"status": "Active",
"medium": "<Print | Digital | Print + digital>",
"first_name": "<string>",
"last_name": "<string>",
"shipping_address": {
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"country_name": "<string>",
"phone": "<string>"
},
"length": "<number>",
"notes": "<string>",
"is_recurring": "<boolean>",
"is_comp": "<boolean>",
"is_gift": "<boolean>",
"gifter": {
"full_name": "<string>",
"email": "<string>"
},
"promo_code": "<string>",
"discount_amount": "<string>",
"refunded": "<string>",
"currency": "<string>",
"price": "<string>",
"order_date": "<date>",
"start_issue": {
"id": "<string>",
"number": "<number>",
"name": "<string>"
},
"issue_list": [
"<number>"
],
"periods": [
{
"id": "<number>",
"order_date": "<date>",
"is_complete": "<boolean>",
"length": "<number>",
"issue_list": [
"<number>"
]
}
],
"subscriber": {
"id": "<string>",
"full_name": "<string>",
"email": "<string>"
},
"source": {
"id": "<string>",
"name": "<string>"
}
}
]
}