FastSpring Connector
The high-performance FastSpring Connector provides read/write capabilities within your application, allowing you to perform numerous FastSpring operations with minimal coding or even no-coding at all. Integrate FastSpring data into applications such as SSIS, SQL Server, any ODBC-compatible application, or even directly within a programming language using this connector.
Download for SSIS Download for SQL Server and ODBC Documentation
Integrate FastSpring with these applications
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.