FastSpring Connector
Documentation
Version: 1
Documentation

EndPoint Get Subscription Report


Name

get_subscription_report

Description

Parameters

Parameter Label Required Options Description
ReportColumns ReportColumns NO
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
GroupByColumns GroupByColumns NO
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
PageSize PageSize NO
StartDate StartDate NO
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
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)
EndDate EndDate NO
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
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)
SyncDate SyncDate NO
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
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)
Country Country NO
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
ProductPaths ProductPaths NO
ProductNames ProductNames NO
NotificationEmails NotificationEmails NO

Output Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.