Endpoint

List All Customers

Name

get_customers

Description

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first. [API reference]

Related Tables

Customers

Parameters

Parameter

Label

Required

Options

Description

Email Id

A case-sensitive filter on the list based on the customer’s email field. The value must be a string.

created_gt

Created later than (yyyy-MM-dd)

Option	Value
today	today
yesterday	yesterday
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
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Return results where the created field is greater than this value.

created_gte

Created on or later than (yyyy-MM-dd)

Option	Value
today	today
yesterday	yesterday
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
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Return results where the created field is greater than or equal to this value.

created_lt

Created earlier than (yyyy-MM-dd)

Option	Value
today	today
yesterday	yesterday
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
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Return results where the created field is less than this value.

created_lte

Created on or earlier than (yyyy-MM-dd)

Option	Value
today	today
yesterday	yesterday
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
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Return results where the created field is less than or equal to this value.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(100)`	100	`False`
Object	`DT_WSTR`	`nvarchar(100)`	100	`False`
Name	`DT_WSTR`	`nvarchar(255)`	255	`False`
Email	`DT_WSTR`	`nvarchar(100)`	100	`False`
Description	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
Phone	`DT_WSTR`	`nvarchar(100)`	100	`False`
PaymentMethod	`DT_WSTR`	`nvarchar(100)`	100	`False`
DefaultSource	`DT_WSTR`	`nvarchar(100)`	100	`False`
DefaultCurrency	`DT_WSTR`	`nvarchar(100)`	100	`False`
Balance	`DT_WSTR`	`nvarchar(100)`	100	`False`
Coupon	`DT_WSTR`	`nvarchar(100)`	100	`False`
PreferredLocales	`DT_WSTR`	`nvarchar(100)`	100	`True`
PromotionCode	`DT_WSTR`	`nvarchar(100)`	100	`False`
AddressLine1	`DT_WSTR`	`nvarchar(100)`	100	`False`
AddressLine2	`DT_WSTR`	`nvarchar(100)`	100	`False`
AddressCity	`DT_WSTR`	`nvarchar(100)`	100	`False`
AddressState	`DT_WSTR`	`nvarchar(100)`	100	`False`
AddressCountry	`DT_WSTR`	`nvarchar(100)`	100	`False`
AddressPostalCode	`DT_WSTR`	`nvarchar(100)`	100	`False`
ShippingName	`DT_WSTR`	`nvarchar(255)`	255	`False`
ShippingPhone	`DT_WSTR`	`nvarchar(100)`	100	`False`
ShippingAddressLine1	`DT_WSTR`	`nvarchar(100)`	100	`False`
ShippingAddressLine2	`DT_WSTR`	`nvarchar(100)`	100	`False`
ShippingAddressCity	`DT_WSTR`	`nvarchar(100)`	100	`False`
ShippingAddressCountry	`DT_WSTR`	`nvarchar(100)`	100	`False`
ShippingAddressState	`DT_WSTR`	`nvarchar(100)`	100	`False`
ShippingAddressPostalCode	`DT_WSTR`	`nvarchar(100)`	100	`False`
TaxIDType	`DT_WSTR`	`nvarchar(100)`	100	`False`
TaxIDValue	`DT_WSTR`	`nvarchar(100)`	100	`False`
InvoicePrefix	`DT_WSTR`	`nvarchar(100)`	100	`False`
InvoiceSettingsDefaultPaymentMethod	`DT_WSTR`	`nvarchar(100)`	100	`False`
InvoiceSettingsFooter	`DT_WSTR`	`nvarchar(100)`	100	`False`
NextInvoiceSequence	`DT_WSTR`	`nvarchar(100)`	100	`False`
TaxExempt	`DT_WSTR`	`nvarchar(100)`	100	`False`
Created	`DT_DBTIMESTAMP`	`datetime`		`False`
LiveMode	`DT_WSTR`	`nvarchar(100)`	100	`False`
Metadata	`DT_WSTR`	`nvarchar(1000)`	1000	`False`

If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

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.

Examples

SSIS

Use Stripe Connector in API Source component to read data or in API Destination component to read/write data:

Read from Customers table using API Destination

This Endpoint belongs to Customers table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Stripe

Customers

Select

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

List all customers

SELECT * FROM get_customers

Get all Customers

Read all customers

SELECT * FROM Customers

get_customers endpoint belongs to Customers 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:

List all customers

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_customers';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

Get all Customers

Read all customers

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Customers';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

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