Endpoint

Delete a Customer

Name

delete_customer

Description

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer. [API reference]

Related Tables

Customers

Parameters

Parameter	Label	Required	Options	Description
Id	Customer Id	YES		Unique identifier for the Customer

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
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Required columns that you need to supply are bolded.

Examples

SSIS

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

Delete rows 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

Delete

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Delete a customer

SELECT * FROM delete_customer
WITH
(
    "Id" = 'abcd-1234-id'
)

Delete a Customer

Delete a customer by Id

DELETE FROM Customers
WHERE Id = 'abc'

delete_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:

Delete a customer

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM delete_customer
WITH
(
    "Id" = ''abcd-1234-id''
)';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

Delete a Customer

Delete a customer by Id

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

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

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