Retrieve a subscription renewal report

Retrieve a subscription renewal report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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
planId
string <= 50 characters

Plan identifier for which subscriptions are counted.

allRenewalCount
integer

All renewed subscriptions number.

allDunningCount
integer

All dunned subscriptions number.

abandonedCount
integer

Abandon subscriptions number.

paidRenewalCount
integer

Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal success rate.

paidDunningCount
integer

Number of paid dunned subscriptions. Divide by allDunningCount to know the dun success rate.

refundedRenewalCount
integer

Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal refund rate.

refundedDunningCount
integer

Number of paid dunned subscriptions. Divide by allDunningCount to know the dun refund rate.

chargebackRenewalCount
integer

Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal chargeback rate.

chargebackDunningCount
integer

Number of paid dunned subscriptions. Divide by allDunningCount to know the dun chargeback rate.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

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