Generates a revenue report

Use /data/v1/revenue to generate a revenue 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 NameDescriptionUsed to group results (groupBy)
Buyer_EmailEmail used by the buyer for the transaction(s)Yes
Buyer_IDUnique ID allocated to buyer in FastSpring's internal systemYes
Chargeback_True_FalseThis is to identify if there was a chargeback on a given transaction. If the value is "True", there is a chargeback on the transaction and if the value is "False" there is no chargeback on the transaction.Yes
Company_IDThe company ID as used by businesses on FastSpring system. This is the ID used to access the app.fastspring.com and get to the landing page with all the stores(SITE_IDs) within a company.Yes
Company_NameName of the business as registered with FastSpringYes
Country_ISO2 letter code that represent a country. This is used to capture the country in buyer's addressYes
Country_NameName of the country in buyer's address for a given transaction recordYes
Coupon"Name of the coupon applied on a given transaction.
Example: As this field can be used to group the records, the reports with transaction grouped by COUPON along with INCOME can give insights into how much revenue each coupon is driving for the business."
Yes
Digital_Backup_Fulfillment_FeeIf the business charges a fee for digital backup of the software from the buyer, this field has the amount in local currency of transaction.No
Digital_Backup_Fulfillment_Fee_in_USDIf the business charges a fee for digital backup of the product from the buyer, this field has the amount in USD. No
Digital_Fulfillment_FeeIf the business charges a fee for fulfillment(usually applies to perpetual license products), this field has the amount in local currencyNo
Digital_Fulfillment_Fee_in_USDIf the business charges a fee for fulfillment(usually applies to perpetual license products), this field has the amount in USDNo
DiscountThe name of the discount configured for the product(s) is stored in this field.Yes
Driving_Offer_TypeThe type of offer that is associated with the parent product in an order is captured in this field. The exhaustive list of offer types is as follows:
cross-sell
upsell
options
bundle
configuration
one_time_fee
addon
Yes
Driving_Product_PathThe parent product with other products tagged in offers is captured here. The product path differs from the product name as the product path is used in the backend by FastSpring system to identify the products. But they both represent the same entity, the products in the catalog.Yes
Fixed_FeeThe fee Fastspring charges on a transaction in local currency.
Note: Use this field for account reconciliation purposes if the payout currency for a given transaction is a currency other than USD
No
Fixed_Fee_in_USDThe fee FastSpring charges on a transaction in USD.
Note: Use this field for account reconciliation purposes if the payout currency for a given transaction is USD.
No
IncomeRevenue the business makes on a transaction before tax, including FastSpring Fee in local currency.
Note: Use this field for account reconciliation purposes if the payout currency for a given transaction is a currency other than USD
Yes
Income_in_USDRevenue the business makes on a transaction before tax, including FastSpring Fee in USD.
Note: Use this field for account reconciliation purposes if the payout currency for a given transaction is USD.
No
Item_IDUnique ID for item(s) in a given order. In a B2B context, there could be large volumes of products within an order and this can help in identifying an item in such large orders.Yes
Order_IDUnique ID for a given transaction. Order and transaction are used interchangeably here and any unique order or transaction can be identified using Order_IDYes
Physical_Backup_Fulfillment_FeeIf the business charges a fee for the physical fulfillment of a product(usually CD/Drive with perpetual license software), the fee amount in local currency is reported here.No
Physical_Backup_Fulfillment_Fee_in_USDIf the business charges a fee for physical fulfillment of a product(usually CD/Drive with perpetual license software), the fee amount in USD is reported here.No
Product_Display_NameThe product name displayed to the customers on the checkout page.Yes
Product_IDUnique ID for a productYes
Product_NameThe product nameYes
Product_PathThe primary key for the productYes
Purchase_TypeFor subscriptions, this field can differentiate between first bill vs recurring bill, meaning when a customer pays for the first time, it is tagged "First" in this field. From the next payment for rest of the subscription's active lifetime, this will be "Recurring" as the customer is paying for the subscription service at fixed intervals(monthly, quarterly etc.)Yes
Return_FeeIf a purchase has been returned and there is a fee for returning the product, it will be captured in this field in the local currency of the transaction. This is a transaction-level fee.No
Return_Fee_in_USDIf a purchase has been returned and there is a fee for returning the product, it will be captured in this field in USD. This is a transaction-level fee.No
Return_True_FalseThis field can be used to know if a transaction has been returned or not. For transactions where the item(s) are returned, this field will have a "True" value and if the transaction did not have problems and went through successfully, this will have a "False"Yes
SegmentIf transactions pass value for reserved Key in Order tag(JSON Key value pair passed in session) FSSegmentation(Not case sensitive),the data can be grouped.
Eg: Order tag with Key: Value in order tag with _FS_Segmentation: B2B
can be used to group all the other fields for just B2B segment.
Yes
Store_Chargeback_FeeIf a transaction was charged back, there is a chargeback fee applied to the transaction. This field captures the value of the chargeback fee on a given transaction. This is a fixed fee charged on a chargeback transaction irrespective of the value of the order.No
Store_IDA unique identifier associated with a store within a company. If a business has multiple stores for different purposes(For example, a store for B2C business vs another store for B2B business), this can used to filter all the transactions for a specific store.Yes
Store_NameIn the hierarchy, a company can have multiple stores under it. This field stores the Store name. The usual purpose of this hierarchy is to separate the categories of business within a company. For example, a business may want to have a separate store for B2C business vs B2B business. Yes
Subscription_PeriodFor a subscription product, the length of the subscription is captured in this field. Conventionally many subscriptions have "1 Month", "1 year", "On Demand" etc.Yes
Subscription_Period_EndThe subscription has recurring payment events so there is a start date and an end date to each payment cycle. This field captures the end date of a subscription cycle. At the end of the cycle, the customer is due to make the payment for using the software for the next period.No
Subscription_Period_StartThe subscription has recurring payment events so there is a start date and an end date to each payment cycle. This field captures the start date of a subscription cycle. At the beginning of the cycle, the customer has paid for using the software until the end of the subscription period.No
Subscription_Start_DateThe date on which a given subscription startedNo
Subscription_StatusThe status of subscription captures what phase in a subscription lifecycle a given subscription is. Below is the exhaustive list of possible values for Subscription status:

Active(Subscription is active meaning the customer can access the software and is willing to pay for subscription service for the upcoming billing cycle)

Canceled(The customer has clicked on the Cancel button and the customer does not want to pay for the software from the upcoming billing cycle)

Canceled Nonpayment (The customer has not voluntarily canceled the subscription. However the system was not able to charge the customer, AKA Involuntary churn resulting from payment decline for a variety of reasons)

Undefined(For managed subscriptions, the billing dates are not defined. As these subscriptions are billed based on the configuration on the seller's end, the status is not defined on FastSpring system. Classic use case being usage-based pricing where the customer has to pay not based on the subscription period but based on usage of the software)

Completed(For Subscriptions that have ended)
Yes
Subscription_True_FalseThis field helps to identify if a product is a subscription product with recurring billing or a one-time purchase perpetual license product. If the field has a "True" value, the product is a subscription product and if the value is "False" then the product is a one-time purchase product.Yes
TaxTax on the transaction in local currencyNo
Tax_FeeFastSpring Fee on the tax for a given transaction in local currencyNo
Tax_Fee_in_USDFastSpring Fee on the tax for a given transaction in USDNo
Tax_in_USDTax on the transaction in USDNo
Transaction_AmountRevenue on a transaction excluding FastSpring fee and Tax in local currencyNo
Transaction_Amount_in_USDRevenue on a transaction excluding FastSpring fee and Tax in USDNo
Transaction_CurrencyCurrency in which the transaction occurred. This field can be relevant for reconciliation if the business receives a payout from FastSpring in more than one currency.Yes
Transaction_DateThe date stamp on which the transaction occurredYes
Transaction_FeeFastSpring fee on the given transaction in local currencyNo
Transaction_Fee_in_USDFastSpring fee on the given transaction in USDNo
Transaction_Item_CountNumber of items in a given order/transaction. Order and transaction are used interchangeably here and any unique order or transaction can be identified using Order_IDNo
Transaction_MonthThe month in which the transaction occurred. The values in the field are in YYYY-MM format and capture the year and month.Yes
Transaction_RateThe percentage of revenue that FastSpring charges the business is captured at a line item level. This can be used to reconcile the FastSpring fee charged at the line item level.No
Transaction_Time_UTCTimestamp of when the transaction occurred in UTC timezoneNo
Transaction_TypeYes
Transaction_YearThe year of the transaction (YYYY)Yes
Grand_Total_In_USDThe grand total of the whole order in USDNo
syncDateWhen reading new data, the last read date.
This field can be used to sync up your DB with FastSpring’s data APIs
No
countryISOThe country code in 2 letter ISO formatYes
Product_CountThe number of unique Product_IDs purchased within a given order. For example, if an order has 10 products in total with 5 units of Product_A and 5 units of Product_B, the value in this field will be 2 because there were 2 unique products in the order. No
Product_UnitsThe number of products purchased in a given order. Following the above example, where an order has 10 products in total with 5 units of Product_A and 5 units of Product_B, this field will have a value of 10, because the total number of units irrespective of products was 10.No
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!