v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Data

Generate subscription report

Generates a subscription report.

You can apply filters on date range, country name, product name, and product path. For each filtered variable, you can define the columns you want to include in your report and how to group results.

post/data/v1/subscription

Request body

reportColumnsstring[]

Columns to include in the subscription report:

Column	Description
activations	Number of activations in the selected period.
arr	Cumulative Annual Run Rate until endDate.
average_mrr	Cumulative Average MRR until endDate.
buyer_email	Buyer’s email address.
buyer_id	Unique ID for the buyer.
cancellations	Number of cancellations in the selected period.
chargeback_true_false	true if the order was charged back, false if successful.
churn_type	Churn type if canceled.
company_id	Seller's unique ID.
company_name	Seller's name.
country_iso	2-letter ISO country code.
country_name	English country name.
coupon	The coupon code used.
customer_churn	Subscriber loss over prior 30 days / active customers 30 days ago.
discount	Discount amount.
driving_offer_type	e.g., cross-sell, upsell, bundle, addon, etc.
driving_product_path	Parent product path.
lifetime_value	Average MRR / customer churn.
mrr	Cumulative Monthly Recurring Revenue until endDate.
mrr_decrease	MRR decrease.
mrr_downgrade	MRR from downgrades in the selected period.
mrr_growth_rate	(current MRR - MRR 30 days ago) / (MRR 30 days ago).
mrr_increase	MRR increase in the selected period.
mrr_paused	MRR from pauses in the selected period.
mrr_resumed	MRR from resumes in the selected period.
mrr_upgrade	MRR from upgrades in the selected period.
new_subscribers	Number of new subscribers in the selected period.
occurred_date	Date of the subscription.
order_id	Order ID.
product_display_name	Display name of the product.
product_id	Internal product ID.
product_name	Product name.
product_path	Primary key for the product.
purchase_type	first or recurring (renewal).
return_true_false	true if returned, false otherwise.
revenue_churn	(MRR decrease) / (MRR 30 days ago).
segment	Group label for a product/country set.
store_id	ID of the store.
store_name	Name of the store.
subscriber_loss	Subscribers lost in the selected period.
subscribers	Cumulative subscribers until endDate.
subscription_id	Unique subscription identifier.
subscription_period	Length of the subscription.
subscription_period_end	End date of the subscription period.
subscription_period_start	Start date of the subscription period.
subscription_quantity	Subscription units from order creation.
subscription_start_date	The subscription’s start date.
subscription_status	The subscription status.
subscription_true_false	true if subscription product, false for a one-time product.
subscriptions	Cumulative subscriptions until endDate.
sync_date	The last sync date for the data.
transaction_currency	Currency of the order.
transaction_date	Date of the order.
transaction_day	Day-month of the transaction.
transaction_month	Month of the transaction.
transaction_time_utc	UTC time of the transaction.
transaction_year	Year of the transaction.

groupBystring[]

Fields used to group or aggregate the data:

Field	Description
buyer_email	Buyer’s email address.
buyer_id	Unique ID for the buyer’s orders.
company_id	The seller’s unique ID.
company_name	The seller’s name.
country_iso	2-letter ISO country code.
country_name	English name for the country.
coupon	The coupon code used.
chargeback_true_false	true if order charged back, false if not.
churn_type	Churn type when canceled.
discount	The discount amount.
driving_offer_type	e.g., cross-sell, upsell, addon, etc.
driving_product_path	The parent product path.
occurred_date	The date of the subscription.
order_id	The order ID.
product_display_name	Display name of the product.
product_id	Internal product ID.
product_name	Product name.
product_path	Primary product path.
purchase_type	first or recurring (renewal).
return_true_false	true if returned, false otherwise.
segment	Groups products/countries with shared traits.
store_id	The store’s ID.
store_name	The store’s name.
subscription_id	Unique subscription identifier.
subscription_period	The subscription length.
subscription_period_end	End date of the subscription period.
subscription_period_start	Start date of the subscription period.
subscription_start_date	The subscription start date.
subscription_status	The subscription status.
subscription_true_false	true if subscription product, false if not.
sync_date	Last sync date.
transaction_currency	The currency of the order.
transaction_date	The date of the order.
transaction_day	Day-month of the subscription transaction.
transaction_month	Month of the transaction.
transaction_year	Year of the transaction.

pageCountinteger

Number of records to return per page.

pageNumberinteger

Specifies the page number of results to be returned.

asyncboolean

Indicates if the report generation was requested asynchronously.

notificationEmailsstring[]

List of emails to notify upon job completion.

Example request

{
  "filter": {
    "startDate": "2025-01-01",
    "endDate": "2025-12-31",
    "syncDate": "2024-12-31"
  },
  "reportColumns": [
    "activations",
    "arr",
    "average_mrr"
  ],
  "groupBy": [
    "buyer_email",
    "buyer_id",
    "company_id",
    "country_iso",
    "product_path",
    "subscription_id",
    "sync_date"
  ],
  "pageCount": 30,
  "pageNumber": 1
}

Response

Example response

{
  "report": [
    {
      "arr": 1080,
      "subscriptions": 1,
      "subscribers": 1,
      "average_mrr": 90,
      "mrr": 90,
      "product_name": "primary subscription (addon-subscription)",
      "occurred_date": "2025-01-01",
      "site_id": "AbC1De2FGhi",
      "country_name": "Uruguay"
    }
  ],
  "request": {
    "filter": {
      "startDate": "2025-01-01",
      "endDate": "2025-12-31",
      "productNames": [
        "primary subscription (addon-subscription)"
      ],
      "countryNames": [
        "Uruguay"
      ]
    },
    "reportColumns": [
      "arr",
      "subscriptions",
      "subscriber_loss",
      "mrr_add_on",
      "product_name"
    ],
    "pageCount": 30,
    "pageNumber": 1,
    "notificationEmails": [
      "jane.doe@example.com"
    ]
  }
}