As of December 13, 2022, the subscription reporting API endpoints have been updated to reflect the improved subscription reporting model data. This update provides more refined and accurate data for analyzing subscription products.
The following sections dive deeper into the updates made to the subscription reporting API:
Endpoints Updated
The following subscription reporting API endpoints have been updated:
GET /1.3/analytics/schema/SubscriptionDetailResult (4)
Returns the XML schema for subscription results.GET /1.3/analytics/schema/SubscriptionTrendsData (5)
Returns the XML schema for subscription trends results.GET /1.3/analytics/schema/SubscriptionDetailResultRow (6)
Returns the XML schema for individual subscription results.GET /1.3/analytics/{role}/subscription/details (9)
Returns subscription details for the given role.GET /1.3/analytics/{role}/subscription/details/canceldate (10)
Returns a list of subscriptions which were canceled within the specified date range.GET /1.3/analytics/{role}/subscription/details/cancelsixty (11)
Returns a list of subscriptions that have been canceled in the last sixty days.GET /1.3/analytics/{role}/subscription/details/cancelthirty (12)
Returns a list of subscriptions that have been canceled in the last thirty days.GET /1.3/analytics/{role}/subscription/details/compsixty (13)
Returns a list of subscriptions that will complete in the next sixty days.GET /1.3/analytics/{role}/subscription/details/compthirty (14)
Returns a list of subscriptions that will complete in the next thirty days.GET /1.3/analytics/{role}/subscription/details/nextpmtdate (15)
Returns a list of subscriptions for which the next payment date is within the specified date range.GET /1.3/analytics/{role}/subscription/details/startdate (16)
Returns a list of subscriptions for which the start date is within the specified date range.GET /1.3/analytics/{role}/subscription/details/status (17)
Returns subscription status data for the given role.GET /1.3/analytics/{role}/subscription/trends (18)
Returns statistical summations of subscription data for a specified date range.
New Fields in the Subscription Reporting API Response
The following response fields have been added to the subscription reporting model and will be returned in the subscription reporting API response as outlined below.
Deprecated Fields in Subscription Endpoints
The following response fields have been deprecated in the new subscription reporting model and the response values returned for the deprecated fields will contain static values as the data is no longer relevant or has been replaced with a new field.
Subscription Endpoint Applicable | Deprecated Field Name | Expected Response |
chargebackAmount | This will always return 0. | |
chargebackCount | This will always return 0. | |
refundAmount | This will always return 0. | |
refundCount | This will always return 0. | |
timeStr | timeStr Always NOT AVAILABLE. Comes from txn_actual_date. | |
txtType | Always empty. Payment method details are available in transaction detail reporting, INS, and orders API. | |
paymentMethod | Always empty. Payment method details are available in transaction detail reporting, INS, and orders API. | |
productId | This will always return 0. Reference itemNo for the relevant product ID data. | |
duration | This will always return 0. |
Modified Trend Report Calculations
netSales
Updated to reflect the gross earnings less the return amounts. Previously net sales always matched gross sales and did not include chargeback and refund deductions.
avgSubAge
The avgSubAge calculation considers subscriptions that fall within the requested startDate and endDate; this includes subscriptions which are active during the requested date range (even if the subscription was started before the requested time period), and those that started, canceled, or completed within the provided startDate and endDate time window. Previously the avgSubAge value returned from the trends API considered all subscriptions for this product, regardless of the startDate and endDate values in the request.
avgSubValue
The avgSubValue calculation considers subscriptions that fall within the requested startDate and endDate. This includes subscriptions which are active during the requested date range (even if the subscription was started before the requested time period), and those that started, canceled, or completed within the provided startDate and endDate time window. Previously the avgSubValue value returned from the trends API considered all subscriptions for this product, regardless of the startDate and endDate values in the request.
avgActiveSubCnt
This calculation has been updated to provide the average number of subscriptions active per day for the requested date range. This includes subscriptions which started prior to the startDate that are still active, and includes subscriptions which started within the requested date range and ended after the specified endDate.
cancelSubCnt
This calculation has been updated to provide the number of subscriptions canceled with an end of service subscription date within the requested startDate and endDate window. It includes subscriptions that may have started prior to the startDate which were canceled within the requested date range.
businessDate
The businessDate will always be returned in the subscription trends response. When groupBy=date is specified in the request, the data is grouped based on the original purchase date. When groupBy is not included in the request, businessDate will be in the response with value: null. NOTE: This is an update from the previous API response which only returned businessDate when the request contained groupedBy=Date.
grossSales
This calculation provides earnings from the initial sale + rebills sales that occurred from subscriptions that are active within the requested date range, as well as subscriptions that started, completed or canceled within the requested date range. NOTE: This is an update from the previous API response based on the subscription records evaluated within startDate and endDate request parameters.
initialSaleAmt
This calculation provides earnings from the initial sales that occurred from subscriptions that are active within the requested date range and subscriptions that started, completed or canceled within the requested date range. NOTE: This is an update from the previous API response based on the subscription records evaluated within startDate and endDate request parameters.
initialSaleCnt
This calculation provides a count of initial sales from the subscriptions which are active within the requested date range and subscriptions that started, completed or canceled within the requested date range. NOTE: In the previous version of the API initial sale count was reported incorrectly as 0.
recurringSaleAmt
This calcuatlions provides earnings from the rebill sales from subscriptions which are active within the requested date range and subscriptions that started, completed or canceled within the requested date range. NOTE: This is an update from the previous API response based on the subscription records evaluated within startDate and endDate request parameters.
recurringSaleCnt
This calculation provides a count of rebill sales from the subscriptions which are active within the requested date range and subscriptions that started, completed or canceled within the requested date range. NOTE: This is an update from the previous API response based on the subscription records evaluated within startDate and endDate request parameters.
TotalSaleCnt
This calculation provides a count of initial sales and rebill sale events from the subscriptions which are active within the requested date range and subscriptions that started, completed or canceled within the requested date range. NOTE: This is an update from the previous API response based on the subscription records evaluated within startDate and endDate request parameters.
Affiliate Access to Subscription Reporting
The subscription reporting API endpoints are available for the subscription product owner only. API requests using the affiliate role will return an empty response as of December 13, 2022. Affiliate support for reporting subscription products earnings and events is provided by the sales analytics tool in the Clickbank dashboard, and/ or through the analytics API referencing rebill sale events and rebill earnings.
Access has been updated based on a modification to the subscription reporting data model which has been designed to provide more accurate, deeper data and reporting tools aligned with a seller’s need to optimize their subscription offers and manage their subscription customers.
Some of this information is sensitive and suitable for the offer owner to view/disclose, and therefore the report is accessible to sellers only. (Although a seller may be able to provide insights upon request, of course.)
If certain subscription data was applicable and valuable for you that’s no longer accessible, please share with our product team your needs for this data by emailing [email protected].