post https://api.fastspring.com/data/v1/subscription
Use /data/v1/subscription to generate a subscription report. You can apply filters on Date range, Country name, Product Name, and Product path. For each of these filtered variables, you can define the columns to be included and how you would like to group results to generate reports and serve your unique business needs.
Report Columns
These columns can be included in the reportColumns field. Some of these columns can be used to group the data by including column names in the groupBy field.
| Column Name | Description | Used to group results (groupBy) |
|---|---|---|
| activations | Number of activations in the selected period of time | No |
| arr | Cumulative Annual Run Rate until the endDate selected. | No |
| average_mrr | Cumulative Average Monthly Recurring Revenue until the endDate selected. | No |
| buyer_email | Buyer’s email address | Yes |
| buyer_id | Unique ID for the buyer’s orders | Yes |
| cancellations | Number of cancelations in the selected period of time | No |
| chargeback_true_false | true - This order was charged backed false - Successful order | Yes |
| chum_type | Churn type when canceled, if not null. | Yes |
| company_id | The sellers uniqueID | Yes |
| company_name | The sellers name | Yes |
| country_iso | The 2 Letter ISO country code | Yes |
| country_name | The English name for the country | Yes |
| coupon | The coupon code | Yes |
| customer_churn | Sum of subscriber loss over the prior 30 days divided by the active customers 30 days ago | No |
| discount | The amount of the discount | Yes |
| driving_offer_type | The related offer type cross-sell upsell options bundle configuration one_time_fee addon | Yes |
| driving_product_path | The parent product path | Yes |
| lifetime_value | The AVG MRR divided by the customer churn (percentage) | No |
| mrr | Cumulative Monthly Recurring Revenue until the endDate selected. | No |
| mrr_decrease | MRR decrease | No |
| mrr_downgrade | MRR from Downgrades from the last 30 days (if grouping by date) MRR from Downgrades in the timeframe selected (if grouping by anything else) | No |
| mrr_growth_rate | (MRR for the current day - MRR 30 days ago)/ MRR 30 days ago | No |
| mrr_increase | MRR Increase from the last 30 days (if grouping by date) MRR Increase in the timeframe selected (if grouping by anything else) | No |
| mrr_paused | MRR from Pauses from the last 30 days (if grouping by date) MRR from Pauses in timeframe selected (if grouping by anything else) | No |
| mrr_resumed | MRR from Resumes from the last 30 days (if grouping by date) MRR from Resumes in timeframe selected (if grouping by anything else) | No |
| mrr_upgrade | MRR from Upgrades from the last 30 days (if grouping by date) MRR from Upgrades in timeframe selected (if grouping by anything else) | No |
| new_subscribers | New subscribers in the selected period of time | No |
| occurred_date | Date of the subscription | Yes |
| order_id | Order id | Yes |
| product_display_name | The product display name | Yes |
| product_id | The internal product id | Yes |
| product_name | The product name | Yes |
| product_path | The primary key for the product | Yes |
| purchase_type | First or Recurring (renewal) | Yes |
| return_true_false | true - Returned false - normal sale | Yes |
| revenue_churn | Sum of MRR decrease over the prior 30 days divided by the MRR 30 days ago | No |
| segment | Divides products/countries into groups with common characteristics defined by the seller | Yes |
| store_id | The store id | Yes |
| store_name | The store name | Yes |
| subscriber_loss | Subscribers lost in the selected period of time | No |
| subscribers | Cumulative number of Subscribers until the endDate selected. | No |
| subscription_id | Unique identifier of the subscription | Yes |
| subscription_period | The subscription length | Yes |
| subscription_period_end | The subscription period end | Yes |
| subscription_period_start | The subscription period start | Yes |
| subscription_quantity | Subscription units quantity from order created | No |
| subscription_start_date | The subscription start date | Yes |
| subscription_status | The subscription status | Yes |
| subscription_true_false | true - subscription product false - normal one time product | Yes |
| subscriptions | Cumulative number of Subscriptions until selected endDate. | No |
| sync_date | Last update | Yes |
| transaction_currency | The currency of this order | Yes |
| transaction_date | The date of the order | Yes |
| transaction_day | The day-month of the subscription transaction | Yes |
| transaction_month | The month of the transaction. | Yes |
| transaction_time_utc | The time of the subscription transaction in UTC timezone | Yes |
| transaction_year | The year of the transaction | Yes |