FastSpring Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » FastSpring Connector » EndPoints > Get Subscriptions

EndPoint Get Subscriptions

Name

get_subscriptions

Description

Parameters

Parameter Label Required Options Description
PageSize PageSize NO
AccountId AccountId NO Account Id
Products Products NO filters results to include only transactions involving the specified product ID(s) / product path(s)
StartDate Start Date (yyyy-MM-dd) NO
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
filters results to include transactions after the specified begin date (must be at least one day before the specified end date)
EndDate End Date (yyyy-MM-dd) NO
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
filters results to include transactions before the specified end date
Event Event NO Event

Output Columns

Label DataType Length Raw Description
Id DT_WSTR 100 False
QuoteId DT_WSTR 1020 False
AccountId DT_WSTR 100 False
ProductId DT_WSTR 100 False
Active DT_BOOL 0 False
State DT_WSTR 24 False
Sku DT_WSTR 1020 False
Display DT_WSTR 1000 False
Quantity DT_I8 0 False
AutoRenew DT_BOOL 0 False
IsSubscriptionEligibleForPauseByBuyer DT_BOOL 0 False
IsPauseScheduled DT_BOOL 0 False
ChangedDate DT_DBDATE 0 False
BeginDate DT_DBDATE 0 False
NextDate DT_DBDATE 0 False
EndDate DT_DBDATE 0 False
CanceledDate DT_DBDATE 0 False
DeactivationDate DT_DBDATE 0 False
NextChargeDate DT_DBDATE 0 False
InitialOrderId DT_WSTR 88 False
InitialOrderReference DT_WSTR 80 False
ImportIdentifier DT_WSTR 80 False
CustomReferenceId DT_WSTR 80 False
MigratedFromSubscriptionId DT_WSTR 80 False
MigratedFromSubscriptionReference DT_WSTR 80 False
MigratedIntoSubscriptionId DT_WSTR 80 False
MigratedIntoSubscriptionReference DT_WSTR 80 False
Adhoc DT_BOOL 0 False
Changed DT_I8 0 False
ChangedValue DT_I8 0 False
ChangedInSeconds DT_I8 0 False
ChangedDisplay DT_WSTR 32 False
ChangedDisplayEmailEnhancements DT_WSTR 48 False
ChangedDisplayEmailEnhancementsWithTime DT_WSTR 96 False
Live DT_BOOL 0 False
Currency DT_WSTR 12 False
Price DT_R8 0 False
PriceDisplay DT_WSTR 36 False
PriceInPayoutCurrency DT_R8 0 False
PriceInPayoutCurrencyDisplay DT_WSTR 36 False
Discount DT_R8 0 False
DiscountDisplay DT_WSTR 20 False
DiscountInPayoutCurrency DT_R8 0 False
DiscountInPayoutCurrencyDisplay DT_WSTR 20 False
Subtotal DT_R8 0 False
SubtotalDisplay DT_WSTR 36 False
SubtotalInPayoutCurrency DT_R8 0 False
SubtotalInPayoutCurrencyDisplay DT_WSTR 36 False
AttributesMigratedProductId DT_WSTR 88 False
AttributesClassicProduct DT_WSTR 984 False
Next DT_I8 0 False
NextValue DT_I8 0 False
NextInSeconds DT_I8 0 False
NextDisplay DT_WSTR 32 False
End DT_WSTR 1020 False
EndValue DT_WSTR 1020 False
EndInSeconds DT_WSTR 1020 False
EndDisplay DT_WSTR 1020 False
CanceledDateValue DT_WSTR 1020 False
CanceledDateInSeconds DT_WSTR 1020 False
CanceledDateDisplay DT_WSTR 1020 False
DeactivationDateNum DT_I8 1020 False
DeactivationDateValue DT_WSTR 1020 False
DeactivationDateInSeconds DT_WSTR 1020 False
DeactivationDateDisplay DT_WSTR 1020 False
Sequence DT_I8 0 False
Periods DT_WSTR 1020 False
RemainingPeriods DT_WSTR 1020 False
Begin DT_I8 0 False
BeginValue DT_I8 0 False
BeginInSeconds DT_I8 0 False
BeginDisplay DT_WSTR 32 False
BeginDisplayEmailEnhancements DT_WSTR 48 False
BeginDisplayEmailEnhancementsWithTime DT_WSTR 96 False
NextDisplayEmailEnhancements DT_WSTR 48 False
NextDisplayEmailEnhancementsWithTime DT_WSTR 96 False
IntervalUnit DT_WSTR 16 False
IntervalUnitAbbreviation DT_WSTR 8 False
IntervalLength DT_I8 0 False
IntervalLengthGtOne DT_BOOL 0 False
NextChargeCurrency DT_WSTR 12 False
NextChargeDateNum DT_I8 0 False
NextChargeDateValue DT_I8 0 False
NextChargeDateInSeconds DT_I8 0 False
NextChargeDateDisplay DT_WSTR 32 False
NextChargePreTax DT_R8 0 False
NextChargePreTaxDisplay DT_WSTR 36 False
NextChargePreTaxInPayoutCurrency DT_R8 0 False
NextChargePreTaxInPayoutCurrencyDisplay DT_WSTR 36 False
NextChargeTotal DT_R8 0 False
NextChargeTotalDisplay DT_WSTR 36 False
NextChargeTotalInPayoutCurrency DT_R8 0 False
NextChargeTotalInPayoutCurrencyDisplay DT_WSTR 36 False
CancellationSettingCancellation DT_WSTR 84 False
CancellationSettingIntervalUnit DT_WSTR 16 False
CancellationSettingIntervalLength DT_I8 0 False
Instructions DT_NTEXT 0 False
Expiry DT_WSTR 10 False
DeclineReason DT_WSTR 1000 False
CardType DT_WSTR 100 False
CardEnding DT_WSTR 20 False

Input Columns

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