Reference

Endpoint Get Subscription Report

Name

get_subscription_report

Description

Parameters

Parameter Required Options
Name: ReportColumns

Label: ReportColumns
Option Value
activations activations
arr arr
average_mrr average_mrr
buyer_email buyer_email
buyer_id buyer_id
cancellations cancellations
chargeback_true_false chargeback_true_false
company_id company_id
company_name company_name
country_iso country_iso
country_name country_name
coupon coupon
customer_churn customer_churn
discount discount
driving_offer_type driving_offer_type
driving_product_path driving_product_path
item_id item_id
lifetime_value lifetime_value
mrr mrr
mrr_decrease mrr_decrease
mrr_downgrade mrr_downgrade
mrr_growth_rate mrr_growth_rate
mrr_increase mrr_increase
mrr_paused mrr_paused
mrr_resumed mrr_resumed
mrr_upgrade mrr_upgrade
new_subscribers new_subscribers
occurred_date occurred_date
order_id order_id
product_display_name product_display_name
product_id product_id
product_name product_name
product_path product_path
purchase_type purchase_type
return_true_false return_true_false
revenue_churn revenue_churn
store_id store_id
store_name store_name
subscriber_loss subscriber_loss
subscribers subscribers
subscription_period subscription_period
subscription_period_end subscription_period_end
subscription_period_start subscription_period_start
subscription_start_date subscription_start_date
subscription_status subscription_status
subscription_true_false subscription_true_false
subscriptions subscriptions
sync_date sync_date
transaction_currency transaction_currency
transaction_date transaction_date
transaction_month transaction_month
transaction_type transaction_type
transaction_year transaction_year
Name: GroupByColumns

Label: GroupByColumns
Option Value
buyer_email buyer_email
buyer_id buyer_id
chargeback_true_false chargeback_true_false
company_id company_id
company_name company_name
country_iso country_iso
country_name country_name
coupon coupon
discount discount
driving_offer_type driving_offer_type
driving_product_path driving_product_path
item_id item_id
occurred_date occurred_date
order_id order_id
product_display_name product_display_name
product_id product_id
product_name product_name
product_path product_path
purchase_type purchase_type
return_true_false return_true_false
store_id store_id
store_name store_name
subscription_period subscription_period
subscription_period_end subscription_period_end
subscription_period_start subscription_period_start
subscription_start_date subscription_start_date
subscription_status subscription_status
subscription_true_false subscription_true_false
sync_date sync_date
transaction_currency transaction_currency
transaction_date transaction_date
transaction_month transaction_month
transaction_type transaction_type
transaction_year transaction_year
Name: PageSize

Label: PageSize
Name: StartDate

Label: StartDate

The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
Name: EndDate

Label: EndDate

The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
Name: SyncDate

Label: SyncDate

The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
Name: Country

Label: Country
Option Value
Albania AL
Argentina AR
Aruba AW
Australia AU
Austria AT
Azerbaijan AZ
Belgium BE
Brazil BR
British Virgin Islands VG
Bulgaria BG
Canada CA
CANADA CANADA
Chile CL
China CN
Colombia CO
Costa Rica CR
Croatia HR
CW CW
Cyprus CY
Czech Republic CZ
Denmark DK
Dominican Republic DO
Ecuador EC
Egypt EG
Estonia EE
Finland FI
FINLAND FINLAND
France FR
French Polynesia PF
Germany DE
Gibraltar GI
Greece GR
Guatemala GT
Honduras HN
Hong Kong, SAR China HK
Hungary HU
Iceland IS
India IN
Indonesia ID
Ireland IE
Isle of Man IM
Israel IL
Italy IT
Jamaica JM
Japan JP
Korea (South) KR
Latvia LV
Lithuania LT
Luxembourg LU
Malaysia MY
Malta Malta
Mauritius MU
Mexico MX
Netherlands NL
New Zealand NZ
Nigeria NG
Norway NO
Peru PE
Philippines PH
Poland PL
Portugal PT
Puerto Rico PR
Qatar QA
Romania RO
Russian Federation RU
Saudi Arabia SA
Singapore SG
Slovakia SK
Slovenia SI
South Africa ZA
Spain ES
Sri Lanka LK
Sweden SE
Switzerland CH
Thailand TH
Trinidad and Tobago TT
Turkey TR
Ukraine UA
United Arab Emirates AE
United Kingdom GB
United States of America US
USA USA
Viet Nam VN
Name: ProductPaths

Label: ProductPaths
Name: ProductNames

Label: ProductNames
Name: NotificationEmails

Label: NotificationEmails

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing FastSpring Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use FastSpring Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - FastSpring
Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
FastSpring
Get Subscription Report
Optional Parameters
ReportColumns transaction_year~transaction_month~transaction_date~subscriptions~new_subscribers
GroupByColumns transaction_year~transaction_month~transaction_date
SSIS API Source - Read from table or endpoint

API Destination

API Destination - FastSpring
Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
FastSpring
Get Subscription Report
Optional Parameters
ReportColumns transaction_year~transaction_month~transaction_date~subscriptions~new_subscribers
GroupByColumns transaction_year~transaction_month~transaction_date
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Generate Subscription Report by Date, Product, Group By

Generate subscription report for selected group by columns, date range, products and more 

SELECT *
FROM get_subscription_report
Order by transaction_date
WITH(
	  Country='AL~UA~US'
	, ProductPaths='odbc-pp-ent-sub~odbc-pp-pro-sub~odbc-pp-std~ssis-pp-pro-sub~ssis-pp-std-sub~ssis-pp-ent-sub'
	, StartDate='monthstart-1m' --or  2022-01-01
	, EndDateDate='monthend+2d' --or  2022-01-01
	, ReportColumns='transaction_date~transaction_month~transaction_year~activations~average_mrr~cancellations~mrr~new_subscribers~subscriptions'
	, GroupByColumns='transaction_date~transaction_month~transaction_year'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Generate Subscription Report by Date, Product, Group By

Generate subscription report for selected group by columns, date range, products and more 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM get_subscription_report
Order by transaction_date
WITH(
	  Country=''AL~UA~US''
	, ProductPaths=''odbc-pp-ent-sub~odbc-pp-pro-sub~odbc-pp-std~ssis-pp-pro-sub~ssis-pp-std-sub~ssis-pp-ent-sub''
	, StartDate=''monthstart-1m'' --or  2022-01-01
	, EndDateDate=''monthend+2d'' --or  2022-01-01
	, ReportColumns=''transaction_date~transaction_month~transaction_year~activations~average_mrr~cancellations~mrr~new_subscribers~subscriptions''
	, GroupByColumns=''transaction_date~transaction_month~transaction_year''
)';

EXEC (@MyQuery) AT [LS_TO_FASTSPRING_IN_GATEWAY];