HomeAPI Reference
API Reference
Start typing to search…

List New Subscriptions

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

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

Query Params
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.

string

Filter records created on or after the specified start_date.

string

Filter records created before the specified start_date.

string

Filter records created on or before the specified start_date.

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.

number

Filter records where discount_percent is greater than the specified value.

number

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

number

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

number

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

number

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

string

Filter records where discount_amount is greater than the specified value.

string

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

string

Filter records where discount_amount is less than the specified value.

string

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

string

Filter records where discount_amount is equal to the specified value.

integer

Filter records where discount_duration_months is greater than the specified value.

integer

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

integer

Filter records where discount_duration_months is less than the specified value.

integer

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

integer

Filter records where discount_duration_months is equal to the specified value.

integer

Filter records where trial_period_days is greater than the specified value.

integer

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

integer

Filter records where trial_period_days is less than the specified value.

integer

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

integer

Filter records where trial_period_days is equal to the specified value.

string

Filter records where amount is greater than the specified value.

string

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

string

Filter records where amount is less than the specified value.

string

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

string

Filter records where amount is equal to the specified value.

string | null
enum

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

Allowed:
string

Filter records by currency.

string

Filter records by consumer_email.

string

Filter records by consumer_id.

string

Filter records by plan_id.

string

Filter records by consumer name.

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
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

Updated 5 months ago

Language
Credentials
Query
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago