GET
https://api.subscriptiongenius.com/2/subscriptions/
Paramater |
Description |
Required |
Default |
Data Type |
campaign_active |
Subscription eligable for automated renewal campaigns |
No |
|
Bool |
copies |
Exact match of copies in a subscription |
No |
|
Integer |
issues_left |
Exact match of issues left in a subscription |
No |
|
Integer |
limit |
Number of subscriptions returned (max 100) |
No |
100 |
Integer |
max_copies |
Filter by minimum copies in a subscription |
No |
|
Integer |
max_issues_left |
Filter by maximum issues left in a subscription |
No |
|
Integer |
min_copies |
Filter by minimum issues left in a subscription |
No |
|
Integer |
min_issues_left |
Filter by minimum issues left in a subscription |
No |
|
Integer |
publication_id |
Unique reference id to publications |
No |
|
Integer |
subscriber_id |
Filter by subscriber's id |
No |
|
Integer |
type |
Filter by subscription type |
No |
|
Print, Digital, Both' |
Paramater |
Description |
Data Type |
subscriptions.audit_classification |
Audit Codes - See Support Documentation |
|
subscriptions.audit_request_type |
Audit Codes - See Support Documentation |
|
subscriptions.billing_address_id |
Unique reference id to addresses |
Integer |
subscriptions.copies |
Number of copies received per issue |
Integer |
subscriptions.date_created |
Date subscription was created (YYYY-MM-DD) |
Date |
subscriptions.date_expired |
Date subscription expired on (YYYY-MM-DD) |
Date |
subscriptions.date_last_renewed |
Date subscription last renewed on (YYYY-MM-DD) |
|
subscriptions.issues |
Number of issues remaining in subscription (-1 is Unlimited) |
Integer |
subscriptions.last_purchase_bundle_id |
Last bundle purchased affecting this subscription |
Integer |
subscriptions.last_purchase_id |
|
|
subscriptions.mailing_address_id |
Unique reference id to addresses |
Integer |
subscriptions.paid_issues_left |
Number of paid issues remaining to calculate deferred revenue with |
|
subscriptions.publication_id |
Unique reference id to publication |
Integer |
subscriptions.renew_campaign_active |
If subscription is eligible for renewal notices |
Bool |
subscriptions.subscription_id |
Unique reference id to subscription |
Integer |
subscriptions.type |
Subscription type: Print, Digital, Both |
String |
subscriptions.unearned_revenue |
|
|
{
"type":"Print",
"issues_left":5,
"limit":3
}
{
"subscriptions":[
{
"subscription_id":"198217",
"publication_id":"45",
"mailing_address_id":"191563",
"billing_address_id":"191563",
"issues":"3",
"copies":"1",
"paid_issues_left":null,
"unearned_revenue":null,
"type":"Print",
"date_created":"2011-10-28",
"date_expired":null,
"date_last_renewed":null,
"last_purchase_bundle_id":"332",
"renew_campaign_active":true,
"audit_classification":null,
"audit_request_type":null
},
{
"subscription_id":"198218",
"publication_id":"47",
"mailing_address_id":"191563",
"billing_address_id":"191563",
"issues":"4",
"copies":"1",
"paid_issues_left":null,
"unearned_revenue":null,
"type":"Print",
"date_created":"2011-10-28",
"date_expired":null,
"date_last_renewed":null,
"last_purchase_bundle_id":"332",
"renew_campaign_active":true,
"audit_classification":null,
"audit_request_type":null
},
{
"subscription_id":"198219",
"publication_id":"49",
"mailing_address_id":"191563",
"billing_address_id":"191563",
"issues":"6",
"copies":"1",
"paid_issues_left":null,
"unearned_revenue":null,
"type":"Print",
"date_created":"2011-10-28",
"date_expired":null,
"date_last_renewed":null,
"last_purchase_bundle_id":"332",
"renew_campaign_active":true,
"audit_classification":null,
"audit_request_type":null
}
]
}