# Retrieve a subscription renewal report

Retrieves a subscription renewal report.

Endpoint: GET /experimental/reports/subscription-renewal
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `periodStart` (string, required)
    Date and time when the report starts.

  - `periodEnd` (string, required)
    Date and time when the report ends.

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

## Response 200 fields (application/json):

  - `data` (array)
    Subscription renewal data.

  - `data.planId` (string)
    Plan ID for which subscriptions are counted.
    Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"

  - `data.allRenewalCount` (integer)
    Total number of renewed subscriptions.

  - `data.allDunningCount` (integer)
    Total number of dunned subscriptions.
Dunning is the process of retrying unsuccessful payment transactions.

  - `data.abandonedCount` (integer)
    Total number of abandoned subscriptions.

  - `data.paidRenewalCount` (integer)
    Total number of paid renewed subscriptions.
To determine the renewal rate,
divide the value of this field by the  value.

  - `data.paidDunningCount` (integer)
    Total number of paid dunned subscriptions.
To determine the dunning success rate,
divide the value of this field by the  value.

  - `data.refundedRenewalCount` (integer)
    Total number of paid renewed subscriptions.
To determine the renewal refund rate,
divide the value of this field by the  value.

  - `data.refundedDunningCount` (integer)
    Total number of paid dunned subscriptions.
To determine the dunning refund rate,
divide the value of this field by the  value.

  - `data.chargebackRenewalCount` (integer)
    Total number of paid renewed subscriptions.
To determine the renewal chargeback rate,
divide the value of this field by the  value.

  - `data.chargebackDunningCount` (integer)
    Total number of paid dunned subscriptions.
To determine the dunning chargeback rate,
divide the value of this field by the  value.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.