FastSpring Connector for SSISRead / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding. In this article you will learn how to quickly and efficiently integrate FastSpring data in SSIS without coding. We will use high-performance FastSpring Connector to easily connect to FastSpring and then access the data inside SSIS. Let's follow the steps below to see how we can accomplish that! FastSpring Connector for SSIS is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them). |
Connect to FastSpring in other apps
|
Video Tutorial - Integrate FastSpring data in SSIS
This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:
- How to download and install the required PowerPack for
FastSpring integration in SSIS - How to configure the connection for
FastSpring - Features of the
ZappySys API Source (Authentication / Query Language / Examples / Driver UI) - How to use the
FastSpring in SSIS
Prerequisites
Before we begin, make sure the following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).
Read data from FastSpring in SSIS (Export data)
In this section we will learn how to configure and use FastSpring Connector in API Source to extract data from FastSpring.
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled FastSpring Connector from Popular Connector List or press Search Online radio button to download FastSpring Connector. Once downloaded simply use it in the configuration:
FastSpring -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
Steps how to get and use FastSpring credentials : API Credentials [Http]
Here is how to obtain FastSpring API credentials:
- In the FastSpring portal, navigate to Developer Tools > APIs > API Credentials.
-
Click Create, FastSpring will automatically generate your Username and Password.
Copy them, we will need them in the next step:
WARNING: Securely store the credentials for future reference.
-
Now go to SSIS package or ODBC data source and use this token in API Credentials authentication configuration:
- In the UserName field paste the Username value you copied in the previous step.
- In the Password field paste the Password value you copied in the previous step.
- Click Test Connection to confirm the connection is working.
- Done! Now you are ready to use FastSpring Connector!
Configuring authentication parameters
FastSpringAPI Credentials [Http]https://api.fastspring.comRequired Parameters UserName Fill-in the parameter... Password Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True Your Webstore URL https://YOUR-STORE.onfastspring.com -
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - FastSpringRead / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding. -
That's it! We are done! Just in a few clicks we configured the call to FastSpring using FastSpring Connector.
You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
Write data to FastSpring using SSIS (Import data)
In this section we will learn how to configure and use FastSpring Connector in the API Destination to write data to FastSpring.
Video tutorial
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download SSIS PowerPack for
FastSpring integration in SSIS - How to configure connection for
FastSpring - How to write or lookup data to
FastSpring - Features about SSIS API Destination
- Using
FastSpring Connector in SSIS
Step-by-step instructions
In upper section we learned how to read data, now in this section we will learn how to configure FastSpring in the API Source to POST data to the FastSpring.
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
-
Select New Connection to create a new connection:
API Destination - FastSpringRead / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding. -
Use a preinstalled FastSpring Connector from Popular Connector List or press Search Online radio button to download FastSpring Connector. Once downloaded simply use it in the configuration:
FastSpring -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
Steps how to get and use FastSpring credentials : API Credentials [Http]
Here is how to obtain FastSpring API credentials:
- In the FastSpring portal, navigate to Developer Tools > APIs > API Credentials.
-
Click Create, FastSpring will automatically generate your Username and Password.
Copy them, we will need them in the next step:
WARNING: Securely store the credentials for future reference.
-
Now go to SSIS package or ODBC data source and use this token in API Credentials authentication configuration:
- In the UserName field paste the Username value you copied in the previous step.
- In the Password field paste the Password value you copied in the previous step.
- Click Test Connection to confirm the connection is working.
- Done! Now you are ready to use FastSpring Connector!
Configuring authentication parameters
FastSpringAPI Credentials [Http]https://api.fastspring.comRequired Parameters UserName Fill-in the parameter... Password Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True Your Webstore URL https://YOUR-STORE.onfastspring.com -
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - FastSpringRead / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding. -
Finally, map the desired columns:
API Destination - FastSpringRead / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding. -
That's it; we successfully configured the POST API Call. In a few clicks we configured the FastSpring API call using ZappySys FastSpring Connector
Load FastSpring data into SQL Server using Upsert Destination (Insert or Update)
Once you configured the data source, you can load FastSpring data into SQL Server using Upsert Destination.
Upsert Destination can merge or synchronize source data with the target table.
It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets.
Upsert Destination also supports very fast bulk upsert
operation along with bulk delete
.
Upsert operation
- a database operation which performs INSERT
or UPDATE
SQL commands
based on record's existence condition in the target table.
It
Upsert Destination supports INSERT
, UPDATE
, and DELETE
operations,
so it is similar to SQL Server's MERGE
command, except it can be used directly in SSIS package.
-
From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
-
Connect your SSIS source component to Upsert Destination.
-
Double-click on Upsert Destination component to open configuration window.
-
Start by selecting the Action from the list.
-
Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
-
Then select a table from the Target Table list or click New button to create a new table based on the source columns.
-
Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).
-
Finally, click Map All button to map all columns and then select the Key columns to match the columns on:
-
Click OK to save the configuration.
-
Run the package and FastSpring data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
-
Done!
Deploy and schedule SSIS package
After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:
Running SSIS package in Azure Data Factory (ADF)
To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:
Actions supported by FastSpring Connector
FastSpring Connector supports following actions for REST API integration:
Create Product
Description
.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
Id
-
Display
-
Summary
-
Description
-
Action
-
Format
-
Sku
-
TaxCode
-
Image
-
Renew
-
Interval
-
IntervalLength
-
IntervalCount
-
QuantityBehavior
-
QuantityDefault
-
PriceUSD
-
PriceEUR
-
PriceGBP
-
PriceCAD
-
PriceNZD
-
PriceCHF
-
PriceSEK
-
PriceCZK
-
PriceDKK
-
PricePLN
-
PriceSGD
-
PriceJPY
-
PriceCNY
-
PriceHKD
-
PriceINR
-
PriceBRL
-
PriceAUD
-
Trial
-
PaymentCollected
-
PaidTrial
-
FulfillmentInstructions
-
DateLimitsEnabled
-
CancellationInterval
-
CancellationIntervalLength
-
SetupFeeTitle
-
SetupFeePriceUSD
-
SetupFeePriceEUR
-
SetupFeePriceGBP
-
TrialPriceUSD
-
TrialPriceEUR
-
TrialPriceGBP
-
Badge
-
Rank
-
Parent
-
Attributes
-
Fulfillments
Output Fields
The following fields are returned after calling this action:
-
Id
-
Display
-
Summary
-
Description
-
Action
-
Image
-
Format
-
Sku
-
Renew
-
Interval
-
IntervalLength
-
IntervalCount
-
QuantityBehavior
-
QuantityDefault
-
PriceUSD
-
PriceEUR
-
PriceGBP
-
PriceCAD
-
PriceNZD
-
PriceCHF
-
PriceSEK
-
PriceCZK
-
PriceDKK
-
PricePLN
-
PriceSGD
-
PriceJPY
-
PriceCNY
-
PriceHKD
-
PriceINR
-
PriceBRL
-
PriceAUD
-
Trial
-
PaymentCollected
-
PaidTrial
-
FulfillmentInstructions
-
Badge
-
Rank
-
DateLimitsEnabled
-
CancellationInterval
-
CancellationIntervalLength
-
TaxCode
-
TaxCodeDescription
-
Visibility
-
ProductAppReference
-
Parent
-
MigratedProductId
-
ClassicProduct
-
SetupFeeTitle
-
SetupFeePriceUSD
-
SetupFeePriceEUR
-
SetupFeePriceGBP
-
TrialPriceUSD
-
TrialPriceEUR
-
TrialPriceGBP
-
Result
-
ResultAction
-
ResultErrors
-
ResultMessage
Visit documentation for more information.
Get Account By Id
Description
.
Parameters
You can provide the following parameters to this action:
-
Account Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
ContactFirst
-
ContactLast
-
ContactEmail
-
ContactCompany
-
ContactPhone
-
ContactSubscribed
-
AddressLine1
-
AddressLine2
-
City
-
Region
-
RegionCustom
-
PostalCode
-
AddressCompany
-
Language
-
Country
-
LookupGlobal
-
Url
-
PaymentMethods
-
PaymentActive
-
Orders
-
Subscriptions
-
Charges
-
Subscribed
-
TaxExemptionData
Visit documentation for more information.
Get Account Charges
Description
.
Parameters
You can provide the following parameters to this action:
-
PageSize
-
Email
-
Account custom key
-
Account global key
-
Account orderID
-
Account orderReference
-
Account subscriptionId
-
Products
-
Show Returned Only
-
Subscription Status
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
AccountId
-
ChargeDate
-
Total
-
Currency
-
PayoutCurrency
-
TotalInPayoutCurrency
-
Status
-
OrderId
-
OrderReference
-
SubscriptionId
-
Timestamp
-
TimestampValue
-
TimestampInSeconds
-
TimestampDisplay
Visit documentation for more information.
Get Account Charges by Id
Description
.
Parameters
You can provide the following parameters to this action:
-
Account Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
AccountId
-
ChargeDate
-
Total
-
Currency
-
PayoutCurrency
-
TotalInPayoutCurrency
-
Status
-
OrderId
-
OrderReference
-
SubscriptionId
-
Timestamp
-
TimestampValue
-
TimestampInSeconds
-
TimestampDisplay
Visit documentation for more information.
Get Account Orders (For a single account)
Description
.
Parameters
You can provide the following parameters to this action:
-
Account Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Reference
-
Item_1
-
Item_2
-
OrderDate
-
SubtotalInPayoutCurrency
-
TaxInPayoutCurrency
-
TotalInPayoutCurrency
-
DiscountInPayoutCurrency
-
ProratedTotalInPayoutCurrency
-
Currency
-
SubtotalDisplay
-
TaxDisplay
-
TotalDisplay
-
CustomerCompany
-
CustomerEmail
-
CustomerFirst
-
CustomerLast
-
CustomerPhone
-
CustomerSubscribed
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressCountry
-
AddressDisplay
-
AddressPostalCode
-
AddressRegionCode
-
AddressRegion
-
AddressRegionDisplay
-
BuyerReference
-
IpAddress
-
Completed
-
Changed
-
ChangedValue
-
ChangedInSeconds
-
ChangedDisplay
-
ChangedDisplayEmailEnhancements
-
ChangedDisplayEmailEnhancementsWithTime
-
Language
-
Live
-
PayoutCurrency
-
QuoteId
-
InvoiceUrl
-
SiteId
-
AccountId
-
Total
-
TotalInPayoutCurrencyDisplay
-
Tax
-
TaxInPayoutCurrencyDisplay
-
Subtotal
-
SubtotalInPayoutCurrencyDisplay
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrencyDisplay
-
DiscountWithTax
-
DiscountWithTaxDisplay
-
DiscountWithTaxInPayoutCurrency
-
DiscountWithTaxInPayoutCurrencyDisplay
-
BillDescriptor
-
PaymentType
-
PaymentCardEnding
-
PaymentBank
-
PaymentMethodType
-
Recipients
-
Notes
-
AcquisitionTransactionType
-
TaxExemptionData
-
ProratedCreditTotal
-
ProratedCreditTotalDisplay
-
ProratedCreditTotalInPayoutCurrency
-
ProratedCreditTotalInPayoutCurrencyDisplay
-
ProratedDebitTotal
-
ProratedDebitTotalDisplay
-
ProratedDebitTotalInPayoutCurrency
-
ProratedDebitTotalInPayoutCurrencyDisplay
-
ProratedTotal
-
ProratedTotalDisplay
-
ProratedTotalInPayoutCurrencyDisplay
-
IsScsProratedOrder
-
IsScsProratedOrderUpgrade
-
LastFourDigits
-
PreviousOrderReference
-
PreviousOrderInvoiceUrl
-
ReturnId_1
-
ReturnAmount_1
-
ReturnAmountUSD_1
-
SubscriptionId_1
-
SubscriptionId_2
-
SubscriptionId_3
-
Tags
Visit documentation for more information.
Get Account Orders (For all accounts)
Description
.
Parameters
You can provide the following parameters to this action:
-
PageSize
-
Email
-
Account custom key
-
Account global key
-
Account orderID
-
Account orderReference
-
Account subscriptionId
-
Products
-
Show Returned Only
-
Subscription Status
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Reference
-
Item_1
-
Item_2
-
OrderDate
-
SubtotalInPayoutCurrency
-
TaxInPayoutCurrency
-
TotalInPayoutCurrency
-
DiscountInPayoutCurrency
-
ProratedTotalInPayoutCurrency
-
Currency
-
SubtotalDisplay
-
TaxDisplay
-
TotalDisplay
-
CustomerCompany
-
CustomerEmail
-
CustomerFirst
-
CustomerLast
-
CustomerPhone
-
CustomerSubscribed
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressCountry
-
AddressDisplay
-
AddressPostalCode
-
AddressRegionCode
-
AddressRegion
-
AddressRegionDisplay
-
BuyerReference
-
IpAddress
-
Completed
-
Changed
-
ChangedValue
-
ChangedInSeconds
-
ChangedDisplay
-
ChangedDisplayEmailEnhancements
-
ChangedDisplayEmailEnhancementsWithTime
-
Language
-
Live
-
PayoutCurrency
-
QuoteId
-
InvoiceUrl
-
SiteId
-
AccountId
-
Total
-
TotalInPayoutCurrencyDisplay
-
Tax
-
TaxInPayoutCurrencyDisplay
-
Subtotal
-
SubtotalInPayoutCurrencyDisplay
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrencyDisplay
-
DiscountWithTax
-
DiscountWithTaxDisplay
-
DiscountWithTaxInPayoutCurrency
-
DiscountWithTaxInPayoutCurrencyDisplay
-
BillDescriptor
-
PaymentType
-
PaymentCardEnding
-
PaymentBank
-
PaymentMethodType
-
Recipients
-
Notes
-
AcquisitionTransactionType
-
TaxExemptionData
-
ProratedCreditTotal
-
ProratedCreditTotalDisplay
-
ProratedCreditTotalInPayoutCurrency
-
ProratedCreditTotalInPayoutCurrencyDisplay
-
ProratedDebitTotal
-
ProratedDebitTotalDisplay
-
ProratedDebitTotalInPayoutCurrency
-
ProratedDebitTotalInPayoutCurrencyDisplay
-
ProratedTotal
-
ProratedTotalDisplay
-
ProratedTotalInPayoutCurrencyDisplay
-
IsScsProratedOrder
-
IsScsProratedOrderUpgrade
-
LastFourDigits
-
PreviousOrderReference
-
PreviousOrderInvoiceUrl
-
ReturnId_1
-
ReturnAmount_1
-
ReturnAmountUSD_1
-
SubscriptionId_1
-
SubscriptionId_2
-
SubscriptionId_3
-
Tags
Visit documentation for more information.
Get Accounts
Description
.
Parameters
You can provide the following parameters to this action:
-
PageSize
-
Email
-
Account custom key
-
Account global key
-
Account orderID
-
Account orderReference
-
Account subscriptionId
-
Products
-
Show Returned Only
-
Subscription Status
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
ContactFirst
-
ContactLast
-
ContactEmail
-
ContactCompany
-
ContactPhone
-
ContactSubscribed
-
AddressLine1
-
AddressLine2
-
City
-
Region
-
RegionCustom
-
PostalCode
-
AddressCompany
-
Language
-
Country
-
LookupGlobal
-
Url
-
PaymentMethods
-
PaymentActive
-
Orders
-
Subscriptions
-
Charges
-
Subscribed
-
TaxExemptionData
Visit documentation for more information.
Get Order by Id
Description
.
Parameters
You can provide the following parameters to this action:
-
Order Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Reference
-
Item_1
-
Item_2
-
OrderDate
-
SubtotalInPayoutCurrency
-
TaxInPayoutCurrency
-
TotalInPayoutCurrency
-
DiscountInPayoutCurrency
-
ProratedTotalInPayoutCurrency
-
Currency
-
SubtotalDisplay
-
TaxDisplay
-
TotalDisplay
-
CustomerCompany
-
CustomerEmail
-
CustomerFirst
-
CustomerLast
-
CustomerPhone
-
CustomerSubscribed
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressCountry
-
AddressDisplay
-
AddressPostalCode
-
AddressRegionCode
-
AddressRegion
-
AddressRegionDisplay
-
BuyerReference
-
IpAddress
-
Completed
-
Changed
-
ChangedValue
-
ChangedInSeconds
-
ChangedDisplay
-
ChangedDisplayEmailEnhancements
-
ChangedDisplayEmailEnhancementsWithTime
-
Language
-
Live
-
PayoutCurrency
-
QuoteId
-
InvoiceUrl
-
SiteId
-
AccountId
-
Total
-
TotalInPayoutCurrencyDisplay
-
Tax
-
TaxInPayoutCurrencyDisplay
-
Subtotal
-
SubtotalInPayoutCurrencyDisplay
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrencyDisplay
-
DiscountWithTax
-
DiscountWithTaxDisplay
-
DiscountWithTaxInPayoutCurrency
-
DiscountWithTaxInPayoutCurrencyDisplay
-
BillDescriptor
-
PaymentType
-
PaymentCardEnding
-
PaymentBank
-
PaymentMethodType
-
Recipients
-
Notes
-
AcquisitionTransactionType
-
TaxExemptionData
-
ProratedCreditTotal
-
ProratedCreditTotalDisplay
-
ProratedCreditTotalInPayoutCurrency
-
ProratedCreditTotalInPayoutCurrencyDisplay
-
ProratedDebitTotal
-
ProratedDebitTotalDisplay
-
ProratedDebitTotalInPayoutCurrency
-
ProratedDebitTotalInPayoutCurrencyDisplay
-
ProratedTotal
-
ProratedTotalDisplay
-
ProratedTotalInPayoutCurrencyDisplay
-
IsScsProratedOrder
-
IsScsProratedOrderUpgrade
-
LastFourDigits
-
PreviousOrderReference
-
PreviousOrderInvoiceUrl
-
ReturnId_1
-
ReturnAmount_1
-
ReturnAmountUSD_1
-
SubscriptionId_1
-
SubscriptionId_2
-
SubscriptionId_3
-
Tags
Visit documentation for more information.
Get Order Items
Description
.
Parameters
You can provide the following parameters to this action:
-
PageSize
-
Days
-
Start Date (yyyy-MM-dd)
-
End Date (yyyy-MM-dd)
-
Order Status
-
Products
-
Show Returned Only
-
Rebill Only
-
Scope
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
OrderId
-
ProductId
-
Quantity
-
Display
-
Sku
-
ShortDisplay
-
SubscriptionId
-
ImageUrl
-
SubtotalDisplay
-
Subtotal
-
SubtotalInPayoutCurrency
-
SubtotalInPayoutCurrencyDisplay
-
AttributesPathFrom
-
AttributesPathTo
-
AttributesQuantityFrom
-
AttributesQuantityTo
-
AttributesDisplay
-
AttributesTotalChange
-
AttributesTotalProratedCharge
-
AttributesTotalProratedCredit
-
AttributesTotalNetCharge
-
AttributesPreviousCharge
-
AttributesUpcomingCharge
-
AttributesUtilizedPrevious
-
AttributesLapsedPrevious
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrency
-
DiscountInPayoutCurrencyDisplay
-
IsSubscription
-
ChangeQuantity
-
WithholdingsTaxWithholdings
-
ProratedItemChangeAmount
-
ProratedItemChangeAmountDisplay
-
ProratedItemChangeAmountInPayoutCurrency
-
ProratedItemChangeAmountInPayoutCurrencyDisplay
-
ProratedItemProratedCharge
-
ProratedItemProratedChargeDisplay
-
ProratedItemProratedChargeInPayoutCurrency
-
ProratedItemProratedChargeInPayoutCurrencyDisplay
-
ProratedItemCreditAmount
-
ProratedItemCreditAmountDisplay
-
ProratedItemCreditAmountInPayoutCurrency
-
ProratedItemCreditAmountInPayoutCurrencyDisplay
-
ProratedItemTaxAmount
-
ProratedItemTaxAmountDisplay
-
ProratedItemTaxAmountInPayoutCurrency
-
ProratedItemTaxAmountInPayoutCurrencyDisplay
-
ProratedItemTotal
-
ProratedItemTotalDisplay
-
ProratedItemTotalInPayoutCurrency
-
ProratedItemTotalInPayoutCurrencyDisplay
-
AttributesMigratedProductId
-
AttributesClassicProduct
-
IsAddon
-
Reference
-
BuyerReference
-
IpAddress
-
Completed
-
Changed
-
ChangedValue
-
ChangedInSeconds
-
ChangedDisplay
-
OrderDate
-
ChangedDisplayEmailEnhancements
-
ChangedDisplayEmailEnhancementsWithTime
-
Language
-
Live
-
Currency
-
PayoutCurrency
-
QuoteId
-
InvoiceUrl
-
SiteId
-
AccountId
-
Total
-
TotalDisplay
-
TotalInPayoutCurrency
-
TotalInPayoutCurrencyDisplay
-
Tax
-
TaxDisplay
-
TaxInPayoutCurrency
-
TaxInPayoutCurrencyDisplay
-
OrderSubtotal
-
OrderSubtotalDisplay
-
OrderSubtotalInPayoutCurrency
-
OrderSubtotalInPayoutCurrencyDisplay
-
OrderDiscount
-
OrderDiscountDisplay
-
OrderDiscountInPayoutCurrency
-
OrderDiscountInPayoutCurrencyDisplay
-
OrderDiscountWithTax
-
OrderDiscountWithTaxDisplay
-
OrderDiscountWithTaxInPayoutCurrency
-
OrderDiscountWithTaxInPayoutCurrencyDisplay
-
BillDescriptor
-
PaymentType
-
PaymentCardEnding
-
CustomerFirst
-
CustomerLast
-
CustomerEmail
-
CustomerCompany
-
CustomerPhone
-
CustomerSubscribed
-
AddressCity
-
AddressRegionCode
-
AddressRegionDisplay
-
AddressRegion
-
AddressPostalCode
-
AddressCountry
-
AddressDisplay
Visit documentation for more information.
Get Order Items by OrderId
Description
.
Parameters
You can provide the following parameters to this action:
-
Order Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
OrderId
-
ProductId
-
Quantity
-
Display
-
Sku
-
ShortDisplay
-
SubscriptionId
-
ImageUrl
-
SubtotalDisplay
-
Subtotal
-
SubtotalInPayoutCurrency
-
SubtotalInPayoutCurrencyDisplay
-
AttributesPathFrom
-
AttributesPathTo
-
AttributesQuantityFrom
-
AttributesQuantityTo
-
AttributesDisplay
-
AttributesTotalChange
-
AttributesTotalProratedCharge
-
AttributesTotalProratedCredit
-
AttributesTotalNetCharge
-
AttributesPreviousCharge
-
AttributesUpcomingCharge
-
AttributesUtilizedPrevious
-
AttributesLapsedPrevious
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrency
-
DiscountInPayoutCurrencyDisplay
-
IsSubscription
-
ChangeQuantity
-
WithholdingsTaxWithholdings
-
ProratedItemChangeAmount
-
ProratedItemChangeAmountDisplay
-
ProratedItemChangeAmountInPayoutCurrency
-
ProratedItemChangeAmountInPayoutCurrencyDisplay
-
ProratedItemProratedCharge
-
ProratedItemProratedChargeDisplay
-
ProratedItemProratedChargeInPayoutCurrency
-
ProratedItemProratedChargeInPayoutCurrencyDisplay
-
ProratedItemCreditAmount
-
ProratedItemCreditAmountDisplay
-
ProratedItemCreditAmountInPayoutCurrency
-
ProratedItemCreditAmountInPayoutCurrencyDisplay
-
ProratedItemTaxAmount
-
ProratedItemTaxAmountDisplay
-
ProratedItemTaxAmountInPayoutCurrency
-
ProratedItemTaxAmountInPayoutCurrencyDisplay
-
ProratedItemTotal
-
ProratedItemTotalDisplay
-
ProratedItemTotalInPayoutCurrency
-
ProratedItemTotalInPayoutCurrencyDisplay
-
AttributesMigratedProductId
-
AttributesClassicProduct
-
IsAddon
-
Reference
-
BuyerReference
-
IpAddress
-
Completed
-
Changed
-
ChangedValue
-
ChangedInSeconds
-
ChangedDisplay
-
OrderDate
-
ChangedDisplayEmailEnhancements
-
ChangedDisplayEmailEnhancementsWithTime
-
Language
-
Live
-
Currency
-
PayoutCurrency
-
QuoteId
-
InvoiceUrl
-
SiteId
-
AccountId
-
Total
-
TotalDisplay
-
TotalInPayoutCurrency
-
TotalInPayoutCurrencyDisplay
-
Tax
-
TaxDisplay
-
TaxInPayoutCurrency
-
TaxInPayoutCurrencyDisplay
-
OrderSubtotal
-
OrderSubtotalDisplay
-
OrderSubtotalInPayoutCurrency
-
OrderSubtotalInPayoutCurrencyDisplay
-
OrderDiscount
-
OrderDiscountDisplay
-
OrderDiscountInPayoutCurrency
-
OrderDiscountInPayoutCurrencyDisplay
-
OrderDiscountWithTax
-
OrderDiscountWithTaxDisplay
-
OrderDiscountWithTaxInPayoutCurrency
-
OrderDiscountWithTaxInPayoutCurrencyDisplay
-
BillDescriptor
-
PaymentType
-
PaymentCardEnding
-
CustomerFirst
-
CustomerLast
-
CustomerEmail
-
CustomerCompany
-
CustomerPhone
-
CustomerSubscribed
-
AddressCity
-
AddressRegionCode
-
AddressRegionDisplay
-
AddressRegion
-
AddressPostalCode
-
AddressCountry
-
AddressDisplay
Visit documentation for more information.
Get Orders
Description
.
Parameters
You can provide the following parameters to this action:
-
PageSize
-
Days
-
Start Date (yyyy-MM-dd)
-
End Date (yyyy-MM-dd)
-
Order Status
-
Products
-
Show Returned Only
-
Rebill Only
-
Scope
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Reference
-
Item_1
-
Item_2
-
OrderDate
-
SubtotalInPayoutCurrency
-
TaxInPayoutCurrency
-
TotalInPayoutCurrency
-
DiscountInPayoutCurrency
-
ProratedTotalInPayoutCurrency
-
Currency
-
SubtotalDisplay
-
TaxDisplay
-
TotalDisplay
-
CustomerCompany
-
CustomerEmail
-
CustomerFirst
-
CustomerLast
-
CustomerPhone
-
CustomerSubscribed
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressCountry
-
AddressDisplay
-
AddressPostalCode
-
AddressRegionCode
-
AddressRegion
-
AddressRegionDisplay
-
BuyerReference
-
IpAddress
-
Completed
-
Changed
-
ChangedValue
-
ChangedInSeconds
-
ChangedDisplay
-
ChangedDisplayEmailEnhancements
-
ChangedDisplayEmailEnhancementsWithTime
-
Language
-
Live
-
PayoutCurrency
-
QuoteId
-
InvoiceUrl
-
SiteId
-
AccountId
-
Total
-
TotalInPayoutCurrencyDisplay
-
Tax
-
TaxInPayoutCurrencyDisplay
-
Subtotal
-
SubtotalInPayoutCurrencyDisplay
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrencyDisplay
-
DiscountWithTax
-
DiscountWithTaxDisplay
-
DiscountWithTaxInPayoutCurrency
-
DiscountWithTaxInPayoutCurrencyDisplay
-
BillDescriptor
-
PaymentType
-
PaymentCardEnding
-
PaymentBank
-
PaymentMethodType
-
Recipients
-
Notes
-
AcquisitionTransactionType
-
TaxExemptionData
-
ProratedCreditTotal
-
ProratedCreditTotalDisplay
-
ProratedCreditTotalInPayoutCurrency
-
ProratedCreditTotalInPayoutCurrencyDisplay
-
ProratedDebitTotal
-
ProratedDebitTotalDisplay
-
ProratedDebitTotalInPayoutCurrency
-
ProratedDebitTotalInPayoutCurrencyDisplay
-
ProratedTotal
-
ProratedTotalDisplay
-
ProratedTotalInPayoutCurrencyDisplay
-
IsScsProratedOrder
-
IsScsProratedOrderUpgrade
-
LastFourDigits
-
PreviousOrderReference
-
PreviousOrderInvoiceUrl
-
ReturnId_1
-
ReturnAmount_1
-
ReturnAmountUSD_1
-
SubscriptionId_1
-
SubscriptionId_2
-
SubscriptionId_3
-
Tags
Visit documentation for more information.
Get Product
Description
.
Parameters
You can provide the following parameters to this action:
-
Product Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Display
-
Summary
-
Description
-
Action
-
Image
-
Format
-
Sku
-
Renew
-
Interval
-
IntervalLength
-
IntervalCount
-
QuantityBehavior
-
QuantityDefault
-
PriceUSD
-
PriceEUR
-
PriceGBP
-
PriceCAD
-
PriceNZD
-
PriceCHF
-
PriceSEK
-
PriceCZK
-
PriceDKK
-
PricePLN
-
PriceSGD
-
PriceJPY
-
PriceCNY
-
PriceHKD
-
PriceINR
-
PriceBRL
-
PriceAUD
-
Trial
-
PaymentCollected
-
PaidTrial
-
FulfillmentInstructions
-
Badge
-
Rank
-
DateLimitsEnabled
-
CancellationInterval
-
CancellationIntervalLength
-
TaxCode
-
TaxCodeDescription
-
Visibility
-
ProductAppReference
-
Parent
-
MigratedProductId
-
ClassicProduct
-
SetupFeeTitle
-
SetupFeePriceUSD
-
SetupFeePriceEUR
-
SetupFeePriceGBP
-
TrialPriceUSD
-
TrialPriceEUR
-
TrialPriceGBP
Visit documentation for more information.
Get Product IDs
Description
.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
Visit documentation for more information.
Get Product Prices
Description
.
Parameters
You can provide the following parameters to this action:
-
Country Code
-
Currency Code
-
PageSize
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Product
-
Country
-
Currency
-
Price
-
PriceDisplay
-
Discount2DiscountPercent
-
Discount2DiscountValue
-
Discount2DiscountValueDisplay
-
Discount2UnitPrice
-
Discount2UnitPriceDisplay
-
Discount3DiscountPercent
-
Discount3DiscountValue
-
Discount3DiscountValueDisplay
-
Discount3UnitPrice
-
Discount3UnitPriceDisplay
-
Discount4DiscountPercent
-
Discount4DiscountValue
-
Discount4DiscountValueDisplay
-
Discount4UnitPrice
-
Discount4UnitPriceDisplay
-
Discount5DiscountPercent
-
Discount5DiscountValue
-
Discount5DiscountValueDisplay
-
Discount5UnitPrice
-
Discount5UnitPriceDisplay
-
DiscountReason
-
DiscountPeriodCount
-
AvailableStart
-
AvailableEnd
-
SetupFeePrice
-
SetupFeePriceDisplay
-
SetupFeeReason
Visit documentation for more information.
Get Products
Description
.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Display
-
Summary
-
Description
-
Action
-
Image
-
Format
-
Sku
-
Renew
-
Interval
-
IntervalLength
-
IntervalCount
-
QuantityBehavior
-
QuantityDefault
-
PriceUSD
-
PriceEUR
-
PriceGBP
-
PriceCAD
-
PriceNZD
-
PriceCHF
-
PriceSEK
-
PriceCZK
-
PriceDKK
-
PricePLN
-
PriceSGD
-
PriceJPY
-
PriceCNY
-
PriceHKD
-
PriceINR
-
PriceBRL
-
PriceAUD
-
Trial
-
PaymentCollected
-
PaidTrial
-
FulfillmentInstructions
-
Badge
-
Rank
-
DateLimitsEnabled
-
CancellationInterval
-
CancellationIntervalLength
-
TaxCode
-
TaxCodeDescription
-
Visibility
-
ProductAppReference
-
Parent
-
MigratedProductId
-
ClassicProduct
-
SetupFeeTitle
-
SetupFeePriceUSD
-
SetupFeePriceEUR
-
SetupFeePriceGBP
-
TrialPriceUSD
-
TrialPriceEUR
-
TrialPriceGBP
Visit documentation for more information.
Get Products Publish Status
Description
.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
StatusCode
Visit documentation for more information.
Get Quote By Id
Description
.
Parameters
You can provide the following parameters to this action:
-
Quote Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Name
-
Status
-
OrderReference
-
Created
-
Currency
-
TotalInPayoutCurrency
-
SubtotalInPayoutCurrency
-
Item_1
-
Item_2
-
Item_3
-
InvoiceId
-
Coupon
-
Subtotal
-
SubtotalDisplay
-
SubtotalInPayoutCurrencyDisplay
-
Tags
-
Tax
-
TaxRate
-
TaxType
-
Total
-
TotalDisplay
-
TotalInPayoutCurrencyDisplay
-
Updated
-
TaxId
-
RecipientCompany
-
RecipientEmail
-
RecipientFirst
-
RecipientLast
-
RecipientPhone
-
RecipientUserId
-
RecipientAddressAddressLine1
-
RecipientAddressAddressLine2
-
RecipientAddressCity
-
RecipientAddressCountry
-
RecipientAddressPostalCode
-
RecipientAddressRegion
-
CreatedByCompany
-
CreatedByEmail
-
CreatedByFirst
-
CreatedByLast
-
CreatedByPhone
-
CreatedByUserId
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrency
-
DiscountInPayoutCurrencyDisplay
-
Expires
-
ExpirationDateDays
-
FulfillmentTerm
-
BuyerGenerated
-
CopyNotesToInvoice
-
Items
-
Notes
-
NetTermsDays
-
QuoteUrl
-
SiteId
-
StatusHistory
-
Source
-
SourceIP
-
IsGrossTax
Visit documentation for more information.
Get Quotes
Description
.
Parameters
You can provide the following parameters to this action:
-
PageSize
-
Created Begin Date (yyyy-MM-dd)
-
Created End Date (yyyy-MM-dd)
-
Created Email
-
QuoteId
-
SearchFor
-
Statuses
-
Expires Begin Date (yyyy-MM-dd)
-
Expires End Date (yyyy-MM-dd)
-
Expires Before Date (yyyy-MM-dd)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Name
-
Status
-
OrderReference
-
Created
-
Currency
-
TotalInPayoutCurrency
-
SubtotalInPayoutCurrency
-
Item_1
-
Item_2
-
Item_3
-
InvoiceId
-
Coupon
-
Subtotal
-
SubtotalDisplay
-
SubtotalInPayoutCurrencyDisplay
-
Tags
-
Tax
-
TaxRate
-
TaxType
-
Total
-
TotalDisplay
-
TotalInPayoutCurrencyDisplay
-
Updated
-
TaxId
-
RecipientCompany
-
RecipientEmail
-
RecipientFirst
-
RecipientLast
-
RecipientPhone
-
RecipientUserId
-
RecipientAddressAddressLine1
-
RecipientAddressAddressLine2
-
RecipientAddressCity
-
RecipientAddressCountry
-
RecipientAddressPostalCode
-
RecipientAddressRegion
-
CreatedByCompany
-
CreatedByEmail
-
CreatedByFirst
-
CreatedByLast
-
CreatedByPhone
-
CreatedByUserId
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrency
-
DiscountInPayoutCurrencyDisplay
-
Expires
-
ExpirationDateDays
-
FulfillmentTerm
-
BuyerGenerated
-
CopyNotesToInvoice
-
Items
-
Notes
-
NetTermsDays
-
QuoteUrl
-
SiteId
-
StatusHistory
-
Source
-
SourceIP
-
IsGrossTax
Visit documentation for more information.
Get Revenue Report
Description
.
Parameters
You can provide the following parameters to this action:
-
ReportColumns
-
GroupByColumns
-
PageSize
-
StartDate
-
EndDate
-
SyncDate
-
Country
-
ProductPaths
-
ProductNames
-
NotificationEmails
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Get Subscription By Id
Description
.
Parameters
You can provide the following parameters to this action:
-
Subscription Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
QuoteId
-
AccountId
-
ProductId
-
Active
-
State
-
Sku
-
Display
-
Quantity
-
AutoRenew
-
IsSubscriptionEligibleForPauseByBuyer
-
IsPauseScheduled
-
ChangedDate
-
BeginDate
-
NextDate
-
EndDate
-
CanceledDate
-
DeactivationDate
-
NextChargeDate
-
InitialOrderId
-
InitialOrderReference
-
ImportIdentifier
-
CustomReferenceId
-
MigratedFromSubscriptionId
-
MigratedFromSubscriptionReference
-
MigratedIntoSubscriptionId
-
MigratedIntoSubscriptionReference
-
Adhoc
-
Changed
-
ChangedValue
-
ChangedInSeconds
-
ChangedDisplay
-
ChangedDisplayEmailEnhancements
-
ChangedDisplayEmailEnhancementsWithTime
-
Live
-
Currency
-
Price
-
PriceDisplay
-
PriceInPayoutCurrency
-
PriceInPayoutCurrencyDisplay
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrency
-
DiscountInPayoutCurrencyDisplay
-
Subtotal
-
SubtotalDisplay
-
SubtotalInPayoutCurrency
-
SubtotalInPayoutCurrencyDisplay
-
AttributesMigratedProductId
-
AttributesClassicProduct
-
Next
-
NextValue
-
NextInSeconds
-
NextDisplay
-
End
-
EndValue
-
EndInSeconds
-
EndDisplay
-
CanceledDateValue
-
CanceledDateInSeconds
-
CanceledDateDisplay
-
DeactivationDateNum
-
DeactivationDateValue
-
DeactivationDateInSeconds
-
DeactivationDateDisplay
-
Sequence
-
Periods
-
RemainingPeriods
-
Begin
-
BeginValue
-
BeginInSeconds
-
BeginDisplay
-
BeginDisplayEmailEnhancements
-
BeginDisplayEmailEnhancementsWithTime
-
NextDisplayEmailEnhancements
-
NextDisplayEmailEnhancementsWithTime
-
IntervalUnit
-
IntervalUnitAbbreviation
-
IntervalLength
-
IntervalLengthGtOne
-
NextChargeCurrency
-
NextChargeDateNum
-
NextChargeDateValue
-
NextChargeDateInSeconds
-
NextChargeDateDisplay
-
NextChargePreTax
-
NextChargePreTaxDisplay
-
NextChargePreTaxInPayoutCurrency
-
NextChargePreTaxInPayoutCurrencyDisplay
-
NextChargeTotal
-
NextChargeTotalDisplay
-
NextChargeTotalInPayoutCurrency
-
NextChargeTotalInPayoutCurrencyDisplay
-
CancellationSettingCancellation
-
CancellationSettingIntervalUnit
-
CancellationSettingIntervalLength
-
Instructions
-
Expiry
-
DeclineReason
-
CardType
-
CardEnding
Visit documentation for more information.
Get Subscription Report
Description
.
Parameters
You can provide the following parameters to this action:
-
ReportColumns
-
GroupByColumns
-
PageSize
-
StartDate
-
EndDate
-
SyncDate
-
Country
-
ProductPaths
-
ProductNames
-
NotificationEmails
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Get Subscriptions
Description
.
Parameters
You can provide the following parameters to this action:
-
PageSize
-
AccountId
-
Products
-
Start Date (yyyy-MM-dd)
-
End Date (yyyy-MM-dd)
-
Event
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
QuoteId
-
AccountId
-
ProductId
-
Active
-
State
-
Sku
-
Display
-
Quantity
-
AutoRenew
-
IsSubscriptionEligibleForPauseByBuyer
-
IsPauseScheduled
-
ChangedDate
-
BeginDate
-
NextDate
-
EndDate
-
CanceledDate
-
DeactivationDate
-
NextChargeDate
-
InitialOrderId
-
InitialOrderReference
-
ImportIdentifier
-
CustomReferenceId
-
MigratedFromSubscriptionId
-
MigratedFromSubscriptionReference
-
MigratedIntoSubscriptionId
-
MigratedIntoSubscriptionReference
-
Adhoc
-
Changed
-
ChangedValue
-
ChangedInSeconds
-
ChangedDisplay
-
ChangedDisplayEmailEnhancements
-
ChangedDisplayEmailEnhancementsWithTime
-
Live
-
Currency
-
Price
-
PriceDisplay
-
PriceInPayoutCurrency
-
PriceInPayoutCurrencyDisplay
-
Discount
-
DiscountDisplay
-
DiscountInPayoutCurrency
-
DiscountInPayoutCurrencyDisplay
-
Subtotal
-
SubtotalDisplay
-
SubtotalInPayoutCurrency
-
SubtotalInPayoutCurrencyDisplay
-
AttributesMigratedProductId
-
AttributesClassicProduct
-
Next
-
NextValue
-
NextInSeconds
-
NextDisplay
-
End
-
EndValue
-
EndInSeconds
-
EndDisplay
-
CanceledDateValue
-
CanceledDateInSeconds
-
CanceledDateDisplay
-
DeactivationDateNum
-
DeactivationDateValue
-
DeactivationDateInSeconds
-
DeactivationDateDisplay
-
Sequence
-
Periods
-
RemainingPeriods
-
Begin
-
BeginValue
-
BeginInSeconds
-
BeginDisplay
-
BeginDisplayEmailEnhancements
-
BeginDisplayEmailEnhancementsWithTime
-
NextDisplayEmailEnhancements
-
NextDisplayEmailEnhancementsWithTime
-
IntervalUnit
-
IntervalUnitAbbreviation
-
IntervalLength
-
IntervalLengthGtOne
-
NextChargeCurrency
-
NextChargeDateNum
-
NextChargeDateValue
-
NextChargeDateInSeconds
-
NextChargeDateDisplay
-
NextChargePreTax
-
NextChargePreTaxDisplay
-
NextChargePreTaxInPayoutCurrency
-
NextChargePreTaxInPayoutCurrencyDisplay
-
NextChargeTotal
-
NextChargeTotalDisplay
-
NextChargeTotalInPayoutCurrency
-
NextChargeTotalInPayoutCurrencyDisplay
-
CancellationSettingCancellation
-
CancellationSettingIntervalUnit
-
CancellationSettingIntervalLength
-
Instructions
-
Expiry
-
DeclineReason
-
CardType
-
CardEnding
Visit documentation for more information.
Get Subscriptions Ids
Description
.
Parameters
You can provide the following parameters to this action:
-
PageSize
-
AccountId
-
Products
-
Start Date (yyyy-MM-dd)
-
End Date (yyyy-MM-dd)
-
Event
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
Visit documentation for more information.
Update Product
Description
.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
Id
-
Display
-
Summary
-
Description
-
Action
-
Format
-
Sku
-
TaxCode
-
Image
-
Renew
-
Interval
-
IntervalLength
-
IntervalCount
-
QuantityBehavior
-
QuantityDefault
-
PriceUSD
-
PriceEUR
-
PriceGBP
-
PriceCAD
-
PriceNZD
-
PriceCHF
-
PriceSEK
-
PriceCZK
-
PriceDKK
-
PricePLN
-
PriceSGD
-
PriceJPY
-
PriceCNY
-
PriceHKD
-
PriceINR
-
PriceBRL
-
PriceAUD
-
Trial
-
PaymentCollected
-
PaidTrial
-
FulfillmentInstructions
-
DateLimitsEnabled
-
CancellationInterval
-
CancellationIntervalLength
-
SetupFeeTitle
-
SetupFeePriceUSD
-
SetupFeePriceEUR
-
SetupFeePriceGBP
-
TrialPriceUSD
-
TrialPriceEUR
-
TrialPriceGBP
-
Badge
-
Rank
-
Parent
-
Attributes
-
Fulfillments
Output Fields
The following fields are returned after calling this action:
-
Id
-
Display
-
Summary
-
Description
-
Action
-
Image
-
Format
-
Sku
-
Renew
-
Interval
-
IntervalLength
-
IntervalCount
-
QuantityBehavior
-
QuantityDefault
-
PriceUSD
-
PriceEUR
-
PriceGBP
-
PriceCAD
-
PriceNZD
-
PriceCHF
-
PriceSEK
-
PriceCZK
-
PriceDKK
-
PricePLN
-
PriceSGD
-
PriceJPY
-
PriceCNY
-
PriceHKD
-
PriceINR
-
PriceBRL
-
PriceAUD
-
Trial
-
PaymentCollected
-
PaidTrial
-
FulfillmentInstructions
-
Badge
-
Rank
-
DateLimitsEnabled
-
CancellationInterval
-
CancellationIntervalLength
-
TaxCode
-
TaxCodeDescription
-
Visibility
-
ProductAppReference
-
Parent
-
MigratedProductId
-
ClassicProduct
-
SetupFeeTitle
-
SetupFeePriceUSD
-
SetupFeePriceEUR
-
SetupFeePriceGBP
-
TrialPriceUSD
-
TrialPriceEUR
-
TrialPriceGBP
-
Result
-
ResultAction
-
ResultErrors
-
ResultMessage
Visit documentation for more information.
Make Generic API Request
Description
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.
Parameters
You can provide the following parameters to this action:
-
Url
-
Body
-
IsMultiPart
-
Filter
-
Headers
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Make Generic API Request (Bulk Write)
Description
This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.
Parameters
You can provide the following parameters to this action:
-
Url
-
IsMultiPart
-
Filter
-
Headers
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Conclusion
In this article we showed you how to connect to FastSpring in SSIS and integrate data without any coding, saving you time and effort.
We encourage you to download FastSpring Connector for SSIS and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download FastSpring Connector for SSIS Documentation