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 Help]
Parameters
Parameter |
Label |
Required |
Options |
Description |
Id |
Customer Id |
YES |
|
Unique identifier for the Customer
|
Output Columns
Label |
DataType |
Length |
Raw |
Description |
Id |
DT_WSTR |
100 |
False |
|
Object |
DT_WSTR |
100 |
False |
|
Name |
DT_WSTR |
255 |
False |
|
Email |
DT_WSTR |
100 |
False |
|
Description |
DT_WSTR |
4000 |
False |
|
Phone |
DT_WSTR |
100 |
False |
|
PaymentMethod |
DT_WSTR |
100 |
False |
|
DefaultSource |
DT_WSTR |
100 |
False |
|
DefaultCurrency |
DT_WSTR |
100 |
False |
|
Balance |
DT_WSTR |
100 |
False |
|
Coupon |
DT_WSTR |
100 |
False |
|
PreferredLocales |
DT_WSTR |
100 |
True |
|
PromotionCode |
DT_WSTR |
100 |
False |
|
AddressLine1 |
DT_WSTR |
100 |
False |
|
AddressLine2 |
DT_WSTR |
100 |
False |
|
AddressCity |
DT_WSTR |
100 |
False |
|
AddressState |
DT_WSTR |
100 |
False |
|
AddressCountry |
DT_WSTR |
100 |
False |
|
AddressPostalCode |
DT_WSTR |
100 |
False |
|
ShippingName |
DT_WSTR |
255 |
False |
|
ShippingPhone |
DT_WSTR |
100 |
False |
|
ShippingAddressLine1 |
DT_WSTR |
100 |
False |
|
ShippingAddressLine2 |
DT_WSTR |
100 |
False |
|
ShippingAddressCity |
DT_WSTR |
100 |
False |
|
ShippingAddressCountry |
DT_WSTR |
100 |
False |
|
ShippingAddressState |
DT_WSTR |
100 |
False |
|
ShippingAddressPostalCode |
DT_WSTR |
100 |
False |
|
TaxIDType |
DT_WSTR |
100 |
False |
|
TaxIDValue |
DT_WSTR |
100 |
False |
|
InvoicePrefix |
DT_WSTR |
100 |
False |
|
InvoiceSettingsDefaultPaymentMethod |
DT_WSTR |
100 |
False |
|
InvoiceSettingsFooter |
DT_WSTR |
100 |
False |
|
NextInvoiceSequence |
DT_WSTR |
100 |
False |
|
TaxExempt |
DT_WSTR |
100 |
False |
|
Created |
DT_DBTIMESTAMP |
0 |
False |
|
LiveMode |
DT_WSTR |
100 |
False |
|
Metadata |
DT_WSTR |
1000 |
False |
|
Input Columns
Label |
DataType |
Length |
Raw |
Description |
Id |
DT_WSTR |
4000 |
False |
|