Stripe Connector
Documentation
Version: 2
Documentation
Endpoint

Update a Customer

Name

update_customer

Description

Updates the specified customer by setting the values of the parameters passed. [API reference]

Related Tables

Customers

Parameters

Parameter Label Required Options Description
Id Customer Id YES Unique identifier for the Customer
name Name NO The customer’s full name or business name.
description Description NO An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
email Email NO Customer’s email address.
payment_method Payment Method NO The Id of the PaymentMethod to attach to the customer.
phone Phone NO The customer’s phone number.
balance Balance (Enter a numeric Value) NO An integer amount in cents that represents the customer’s current balance, which affect the customer’s future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
coupon Coupon NO If you provide a coupon code, the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount.
preferred_locales Preferred Locales NO Customer’s preferred languages, ordered by preference.
promotion_code Promotion Code NO The API Id of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
tax_id_data_type Tax Id Type (ae_trn, au_abn, br_cnpj, br_cpf etc.) NO
Option Value
ae_trn ae_trn
au_abn au_abn
br_cnpj br_cnpj
br_cpf br_cpf
ca_bn ca_bn
ca_qst ca_qst
ch_vat ch_vat
cl_tin cl_tin
es_cif es_cif
eu_vat eu_vat
hk_br hk_br
id_npwp id_npwp
in_gst in_gst
jp_cn jp_cn
jp_rn jp_rn
kr_brn kr_brn
li_uid li_uid
mx_rfc mx_rfc
my_frp my_frp
my_itn my_itn
my_sst my_sst
no_vat no_vat
nz_gst nz_gst
ru_inn ru_inn
ru_kpp ru_kpp
sa_vat sa_vat
sg_gst sg_gst
sg_uen sg_uen
th_vat th_vat
tw_vat tw_vat
us_ein us_ein
za_vat za_vat
Type of the tax Id, one of ae_trn, au_abn, br_cnpj, br_cpf, ca_bn, ca_qst, ch_vat, cl_tin, es_cif, eu_vat, hk_br, id_npwp, in_gst, jp_cn, jp_rn, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, th_vat, tw_vat, us_ein, or za_vat
tax_id_data_value Tax Id Value NO Value of the tax Id.
address_line1 Address Line1 NO Address line 1 (e.g., street, PO Box, or company name).
address_line2 Address Line2 NO Address line 2 (e.g., apartment, suite, unit, or building).
address_city Address City NO City, district, suburb, town, or village.
address_state Address State NO State, county, province, or region.
address_country Address Country NO Two-letter country code
address_postal_code Address Postal Code NO ZIP or postal code.
shipping_name Shipping Name NO Customer name.
shipping_phone Shipping Phone NO Customer phone (including extension).
shipping_address_line1 Shipping Address Line1 NO Address line 1 (e.g., street, PO Box, or company name).
shipping_address_line2 Shipping Address Line2 NO Address line 2 (e.g., apartment, suite, unit, or building).
shipping_address_city Shipping Address City NO City, district, suburb, town, or village.
shipping_address_state Shipping Address State NO State, county, province, or region.
shipping_address_country Shipping Address Country NO Two-letter country code
shipping_address_postal_code Shipping Address Postal Code NO ZIP or postal code.
invoice_prefix Invoice_Prefix (Must be 3–12 uppercase letters or numbers) NO The prefix for the customer used to generate unique invoice numbers.
invoice_settings_default_payment_method Invoice Settings - Default Payment Method NO ID of a payment method that’s attached to the customer, to be used as the customer’s default payment method for subscriptions and invoices.
invoice_settings_footer Invoice Settings - Footer NO Default footer to be displayed on invoices for this customer.
next_invoice_sequence next_invoice_sequence NO The suffix of the customer’s next invoice number, e.g., 0001.
tax_exempt Tax Exempt (none, exempt, reverse) NO
Option Value
none none
exempt exempt
reverse reverse
Describes the customer tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text Reverse charge.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
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
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
Balance DT_WSTR nvarchar(100) 100 False
Coupon DT_WSTR nvarchar(100) 100 False
tax_id_data_type DT_WSTR nvarchar(4000) 4000 False
tax_id_data_value DT_WSTR nvarchar(4000) 4000 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
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:

Update rows in 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
Update
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Update a customer 

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

Update a Customer

Update a customer 

UPDATE Customers
SET   Name='Cust1-Updated'
	, Email='a-updated@b.com'
	, Phone='+1 800-123-2345'
	, Description='Desc-updated'
	, AddressLine1='Line-1-upd'
	, AddressLine2='Line-2-upd'
	, AddressCity='SomeCity'
	, AddressState='NY'
	, AddressCountry='USA'
	, AddressPostalCode='112233'
	
	, ShippingPhone='+1 800-123-2345'
	, ShippingName='SHName-upd'
	, ShippingAddressLine1='Line-1-upd'
	, ShippingAddressLine2='Line-2-upd'
	, ShippingAddressCity='SomeCity'
	, ShippingAddressState='NY'
	, ShippingAddressCountry='USA'
	, ShippingAddressPostalCode='112233'
	
	, Balance=100	
WHERE Id='cus_IcUG2lD69ZHuol'

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

Update a customer 

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

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

Update a Customer

Update a customer 

DECLARE @MyQuery NVARCHAR(MAX) = 'UPDATE Customers
SET   Name=''Cust1-Updated''
	, Email=''a-updated@b.com''
	, Phone=''+1 800-123-2345''
	, Description=''Desc-updated''
	, AddressLine1=''Line-1-upd''
	, AddressLine2=''Line-2-upd''
	, AddressCity=''SomeCity''
	, AddressState=''NY''
	, AddressCountry=''USA''
	, AddressPostalCode=''112233''
	
	, ShippingPhone=''+1 800-123-2345''
	, ShippingName=''SHName-upd''
	, ShippingAddressLine1=''Line-1-upd''
	, ShippingAddressLine2=''Line-2-upd''
	, ShippingAddressCity=''SomeCity''
	, ShippingAddressState=''NY''
	, ShippingAddressCountry=''USA''
	, ShippingAddressPostalCode=''112233''
	
	, Balance=100	
WHERE Id=''cus_IcUG2lD69ZHuol''';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

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