List New Subscriptions

get

https://analytics.zype.com/v3/revenue/subscriptions

This endpoint will return new subscription analytics data for your property.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filters[start_date_gt]

string

Filter records created after the specified start_date (filters[start_date_gte]=2018-11-01). If no start_date is specified, then data returned will date back two weeks ago.

filters[start_date_gte]

string

Filter records created on or after the specified start_date.

filters[start_date_lt]

string

Filter records created before the specified start_date.

filters[start_date_lte]

string

Filter records created on or before the specified start_date.

filters[start_date_eq]

string

Filter records created on the specified start_date. Comparison is date and time specific. If no time values are submitted, 00:00:00 UTC is assumed.

filters[discount_percent_gt]

number

Filter records where discount_percent is greater than the specified value.

filters[discount_percent_gte]

number

Filter records where discount_percent is greater than or equal to the specified value.

filters[discount_percent_lt]

number

Filter records where discount_percent is less than the specified value`.

filters[discount_percent_lte]

number

Filter records where discount_percent is less than or equal to the specified value.

filters[discount_percent_eq]

number

Filter records where discount_percent is equal to the specified value`.

filters[discount_amount_gt]

string

Filter records where discount_amount is greater than the specified value.

filters[discount_amount_gte]

string

Filter records where discount_amount is greater than or equal to the specified value.

filters[discount_amount_lt]

string

Filter records where discount_amount is less than the specified value.

filters[discount_amount_lte]

string

Filter records where discount_amount is less than or equal to the specified value.

filters[discount_amount_eq]

string

Filter records where discount_amount is equal to the specified value.

filters[discount_duration_months_gt]

integer

Filter records where discount_duration_months is greater than the specified value.

filters[discount_duration_months_gte]

integer

Filter records where discount_duration_months is greater than or equal to the specified value.

filters[discount_duration_months_lt]

integer

Filter records where discount_duration_months is less than the specified value.

filters[discount_duration_months_lte]

integer

Filter records where discount_duration_months is less than or equal to the specified value.

filters[discount_duration_months_eq]

integer

Filter records where discount_duration_months is equal to the specified value.

filters[trial_period_days_gt]

integer

Filter records where trial_period_days is greater than the specified value.

filters[trial_period_days_gte]

integer

Filter records where trial_period_days is greater than or equalt to the specified value.

filters[trial_period_days_lt]

integer

Filter records where trial_period_days is less than the specified value.

filters[trial_period_days_lte]

integer

Filter records where trial_period_days is less than or equal to the specified value.

filters[trial_period_days_eq]

integer

Filter records where trial_period_days is equal to the specified value.

filters[amount_gt]

string

Filter records where amount is greater than the specified value.

filters[amount_gte]

string

Filter records where amount is greater than or equal to the specified value.

filters[amount_lt]

string

Filter records where amount is less than the specified value.

filters[amount_lte]

string

Filter records where amount is less than or equal to the specified value.

filters[amount_eq]

string

Filter records where amount is equal to the specified value.

filters[interval_eq]

string | null

enum

Filter records by subscription interval. Accepted values are month, year, and lifetime.

Allowed:

filters[currency_eq]

string

Filter records by currency.

filters[consumer_email_eq]

string

Filter records by consumer_email.

filters[consumer_id_eq]

string

Filter records by consumer_id.

filters[plan_id_eq]

string

Filter records by plan_id.

filters[name_eq]

string

Filter records by consumer name.

interval

string | null

enum

Group records by time intervals. Accepted values: day, week, month, year.

Allowed:

group_by

array of strings or null

Group by an array of properties. Accepted properties are: interval, coupon_code, discount_percent, discount_duration_months, discount_duration, discount_amount, currency, amount, trial_period_days, name, consumer_email, consumer_id, plan_id, start_date

group_by

sort_by

string | null

enum

Sort results by value of a specific property + '_' + sort direction (Example - sort_by=start_date_asc, or sort_by=consumer_email_desc)

Responses

200See below for example responses

422Unprocessable entity