Reference

Endpoint Get Account Charges

Name

get_account_charges

Description

Related Tables

AccountCharges

Parameters

Parameter Required Options
Name: PageSize

Label: PageSize
Name: Email

Label: Email

Account email
Name: CustomKey

Label: Account custom key
Name: GlobalKey

Label: Account global key
Name: OrderID

Label: Account orderID
Name: OrderReference

Label: Account orderReference
Name: SubscriptionId

Label: Account subscriptionId
Name: Products

Label: Products

filters results to include only transactions involving the specified product ID(s) / product path(s)
Name: Refunds

Label: Show Returned Only

filters results to include orders with or without returns; response includes returns array with return IDs where applicable
Option Value
true true
false false
Name: SubscriptionStatus

Label: Subscription Status

'active', 'ended', 'canceled', 'started' will return accounts with subscriptions in the corresponding state
Option Value
active active
ended ended
canceled canceled
started started

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
AccountId DT_WSTR nvarchar(100) 100
ChargeDate DT_DBDATE date
Total DT_R8 float
Currency DT_WSTR nvarchar(12) 12
PayoutCurrency DT_WSTR nvarchar(12) 12
TotalInPayoutCurrency DT_R8 float
Status DT_WSTR nvarchar(50) 50
OrderId DT_WSTR nvarchar(100) 100
OrderReference DT_WSTR nvarchar(100) 100
SubscriptionId DT_WSTR nvarchar(100) 100
Timestamp DT_I8 bigint
TimestampValue DT_I8 bigint
TimestampInSeconds DT_I8 bigint
TimestampDisplay DT_WSTR nvarchar(100) 100
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

This Endpoint belongs to the AccountCharges table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - FastSpring
Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
FastSpring
AccountCharges
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the AccountCharges table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get account charges:

API Destination - FastSpring
Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
FastSpring
AccountCharges
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get account charges

Use below query to search account charges 

SELECT * from AccountCharges 

--search by one or more parameters below
/*
WITH(
	  Email='X'
	, CustomKey='X'
	, GlobalKey='X'
	, OrderID='X'
	, OrderReference='X'
	, SubscriptionId='X'
	, Products='PROD-1,PROD-2,PROD-3'
	, Refunds='true'
	, SubscriptionStatus='active'
)
*/

get_account_charges endpoint belongs to AccountCharges table(s), and can therefore be used via those table(s).

SQL Server

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

Get account charges

Use below query to search account charges 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * from AccountCharges 

--search by one or more parameters below
/*
WITH(
	  Email=''X''
	, CustomKey=''X''
	, GlobalKey=''X''
	, OrderID=''X''
	, OrderReference=''X''
	, SubscriptionId=''X''
	, Products=''PROD-1,PROD-2,PROD-3''
	, Refunds=''true''
	, SubscriptionStatus=''active''
)
*/';

EXEC (@MyQuery) AT [LS_TO_FASTSPRING_IN_GATEWAY];

get_account_charges endpoint belongs to AccountCharges table(s), and can therefore be used via those table(s).