Retrieve a subscription renewal report

Retrieves a subscription renewal report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string <date-time>

Date and time when the report starts.

periodEnd
required
string <date-time>

Date and time when the report ends.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

Responses
200

Report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

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

Subscription renewal data.

Array
planId
string <= 50 characters

Plan ID for which subscriptions are counted.

allRenewalCount
integer

Total number of renewed subscriptions.

allDunningCount
integer

Total number of dunned subscriptions. Dunning is the process of retrying unsuccessful payment transactions.

abandonedCount
integer

Total number of abandoned subscriptions.

paidRenewalCount
integer

Total number of paid renewed subscriptions. To determine the renewal rate, divide the value of this field by the allRenewalCount value.

paidDunningCount
integer

Total number of paid dunned subscriptions. To determine the dunning success rate, divide the value of this field by the allDunningCount value.

refundedRenewalCount
integer

Total number of paid renewed subscriptions. To determine the renewal refund rate, divide the value of this field by the allRenewalCount value.

refundedDunningCount
integer

Total number of paid dunned subscriptions. To determine the dunning refund rate, divide the value of this field by the allDunningCount value.

chargebackRenewalCount
integer

Total number of paid renewed subscriptions. To determine the renewal chargeback rate, divide the value of this field by the allRenewalCount value.

chargebackDunningCount
integer

Total number of paid dunned subscriptions. To determine the dunning chargeback rate, divide the value of this field by the allDunningCount value.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/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": [
    ]
}