logo

Retrieve transactions with their plan data

Retrieve transactions with their plan data.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

aggregationField
required
string

Report aggregation field.

Enum: "planId" "websiteId" "canceledBy" "cancelCategory" "leadSource.source" "leadSource.medium" "leadSource.campaign" "leadSource.content" "leadSource.term" "leadSource.affiliate" … 2 more
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array of objects
Array
aggregationValue
string

Aggregation value.

count
integer

Count of canceled subscriptions.

averageLength
number <double>

Average length of canceled subscription from start to end within the aggregation in seconds.

medianLength
number <double>

Median length of canceled subscription from start to end within the aggregation in seconds.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/subscription-cancellation
Request samples
const params = {
    aggregationField: 'day',
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getSubscriptionCancellation(params);
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Retrieve a subscription renewal report