EndPoint Get Accounts

Contents

Name

get_accounts

Parameter

Label

Required

Options

Description

PageSize

Account email

CustomKey

Account custom key

GlobalKey

Account global key

OrderID

Account orderID

OrderReference

Account orderReference

SubscriptionId

Account subscriptionId

Products

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

Refunds

Show Returned Only

Option	Value
true	true
false	false

filters results to include orders with or without returns; response includes returns array with return IDs where applicable

SubscriptionStatus

Subscription Status

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

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(50)`	50	False
ContactFirst	`DT_WSTR`	`nvarchar(255)`	255	False
ContactLast	`DT_WSTR`	`nvarchar(255)`	255	False
ContactEmail	`DT_WSTR`	`nvarchar(255)`	255	False
ContactCompany	`DT_WSTR`	`nvarchar(255)`	255	False
ContactPhone	`DT_WSTR`	`nvarchar(255)`	255	False
ContactSubscribed	`DT_BOOL`	`bit`		False
AddressLine1	`DT_WSTR`	`nvarchar(255)`	255	False
AddressLine2	`DT_WSTR`	`nvarchar(255)`	255	False
City	`DT_WSTR`	`nvarchar(255)`	255	False
Region	`DT_WSTR`	`nvarchar(255)`	255	False
RegionCustom	`DT_WSTR`	`nvarchar(255)`	255	False
PostalCode	`DT_WSTR`	`nvarchar(255)`	255	False
AddressCompany	`DT_WSTR`	`nvarchar(255)`	255	False
Language	`DT_WSTR`	`nvarchar(255)`	255	False
Country	`DT_WSTR`	`nvarchar(255)`	255	False
LookupGlobal	`DT_WSTR`	`nvarchar(255)`	255	False
Url	`DT_WSTR`	`nvarchar(255)`	255	False
PaymentMethods	`DT_I8`	`bigint`		False
PaymentActive	`DT_I8`	`bigint`		False
Orders	`DT_NTEXT`	`nvarchar(MAX)`		False
Subscriptions	`DT_NTEXT`	`nvarchar(MAX)`		False
Charges	`DT_NTEXT`	`nvarchar(MAX)`		False
Subscribed	`DT_BOOL`	`bit`		False
TaxExemptionData	`DT_WSTR`	`nvarchar(4000)`	4000	False

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.