Reference

Endpoint Retrieve a Customer

Name

get_single_customer

Description

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation. [API reference]

Related Tables

Customers

Parameters

Parameter	Required	Options
Name: Id Label: Customer Id Unique identifier for the Customer	YES

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length
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
Id	`DT_WSTR`	`nvarchar(4000)`	4000

Required columns that you need to supply are bolded.

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

Required Parameters
Customer Id	Fill-in the parameter...
Optional Parameters
ContineOn404Error	True

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 retrieve a customer:

API Destination - Stripe

This connector support read/write operations for Stripe APIs

Stripe

Customers

Lookup

Required Parameters
Customer Id	Fill-in the parameter...
Optional Parameters
ContineOn404Error	True

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get a Customer

Read a customer

SELECT * FROM Customers
WHERE Id = 'abc'

get_single_customer 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 a Customer

Read a customer

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

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

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