Reference

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 Required Options
Name: email

Label: Email Id

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

Label: Created later than (yyyy-MM-dd)

Return results where the created field is greater than this value.
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
Name: created_gte

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

Return results where the created field is greater than or equal to this value.
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
Name: created_lt

Label: Created earlier than (yyyy-MM-dd)

Return results where the created field is less than this value.
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
Name: created_lte

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

Return results where the created field is less than or equal to this value.
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

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(100) 100
Object DT_WSTR nvarchar(100) 100
Name DT_WSTR nvarchar(255) 255
Email DT_WSTR nvarchar(100) 100
Description DT_WSTR nvarchar(4000) 4000
Phone DT_WSTR nvarchar(100) 100
PaymentMethod DT_WSTR nvarchar(100) 100
DefaultSource DT_WSTR nvarchar(100) 100
DefaultCurrency DT_WSTR nvarchar(100) 100
Balance DT_WSTR nvarchar(100) 100
Coupon DT_WSTR nvarchar(100) 100
PreferredLocales DT_WSTR nvarchar(100) 100
PromotionCode DT_WSTR nvarchar(100) 100
AddressLine1 DT_WSTR nvarchar(100) 100
AddressLine2 DT_WSTR nvarchar(100) 100
AddressCity DT_WSTR nvarchar(100) 100
AddressState DT_WSTR nvarchar(100) 100
AddressCountry DT_WSTR nvarchar(100) 100
AddressPostalCode DT_WSTR nvarchar(100) 100
ShippingName DT_WSTR nvarchar(255) 255
ShippingPhone DT_WSTR nvarchar(100) 100
ShippingAddressLine1 DT_WSTR nvarchar(100) 100
ShippingAddressLine2 DT_WSTR nvarchar(100) 100
ShippingAddressCity DT_WSTR nvarchar(100) 100
ShippingAddressCountry DT_WSTR nvarchar(100) 100
ShippingAddressState DT_WSTR nvarchar(100) 100
ShippingAddressPostalCode DT_WSTR nvarchar(100) 100
TaxIDType DT_WSTR nvarchar(100) 100
TaxIDValue DT_WSTR nvarchar(100) 100
InvoicePrefix DT_WSTR nvarchar(100) 100
InvoiceSettingsDefaultPaymentMethod DT_WSTR nvarchar(100) 100
InvoiceSettingsFooter DT_WSTR nvarchar(100) 100
NextInvoiceSequence DT_WSTR nvarchar(100) 100
TaxExempt DT_WSTR nvarchar(100) 100
Created DT_DBTIMESTAMP datetime
LiveMode DT_WSTR nvarchar(100) 100
Metadata DT_WSTR nvarchar(1000) 1000
If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Customers table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Customers
Optional Parameters
Email Id
Created later than (yyyy-MM-dd)
Created on or later than (yyyy-MM-dd)
Created earlier than (yyyy-MM-dd)
Created on or earlier than (yyyy-MM-dd)
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Customers table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to list all customers:

API Destination - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Customers
Select
Optional Parameters
Email Id
Created later than (yyyy-MM-dd)
Created on or later than (yyyy-MM-dd)
Created earlier than (yyyy-MM-dd)
Created on or earlier than (yyyy-MM-dd)
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

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:

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).