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
Parameters
| Parameter | Required | Options |
|---|---|---|
|
Name:
Label: Customer Id Unique identifier for the Customer |
YES |
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 | |
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 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(4000)
|
4000 |
Examples
SSIS
Use Stripe Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
| Required Parameters | |
|---|---|
| Customer Id | Fill-in the parameter... |
| Optional Parameters | |
| ContineOn404Error | True |
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 delete a customer:
| Required Parameters | |
|---|---|
| Customer Id | Fill-in the parameter... |
| Optional Parameters | |
| ContineOn404Error | True |
ODBC application
Use these SQL queries in your ODBC application data source:
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
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).