Stripe Connector
Documentation
Version: 2
Documentation
Home » API Integration Hub » Stripe Connector » EndPoints > Update a Customer

EndPoint Update a Customer

Name

update_customer

Description

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

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 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
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
Balance DT_WSTR 100 False
Coupon DT_WSTR 100 False
tax_id_data_type DT_WSTR 4000 False
tax_id_data_value DT_WSTR 4000 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