Module customer

Source

Structs§

BalanceTransactionsCustomer
Returns a list of transactions that updated the customer’s balances.
CreateCustomer
Creates a new customer object.
CreateCustomerCashBalance
Balance information and default balance settings for this customer.
CreateCustomerCashBalanceSettings
Settings controlling the behavior of the customer’s cash balance, such as reconciliation of funds received.
CreateCustomerInvoiceSettings
Default invoice settings for this customer.
CreateCustomerInvoiceSettingsRenderingOptions
Default options for invoice PDF rendering for this customer.
CreateCustomerTax
Tax details about the customer.
CreateCustomerTaxIdData
The customer’s tax IDs.
CreateFundingInstructionsCustomer
Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new. funding instructions will be created. If funding instructions have already been created for a given customer, the same. funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
CreateFundingInstructionsCustomerBankTransfer
Additional parameters for bank_transfer funding types
CreateFundingInstructionsCustomerBankTransferEuBankTransfer
Configuration for eu_bank_transfer funding type.
CustomFieldParams
CustomerShipping
DeleteCustomer
Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
DeleteDiscountCustomer
Removes the currently applied discount on a customer.
FundCashBalanceCustomer
Create an incoming testmode bank transfer
ListCustomer
Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
ListPaymentMethodsCustomer
Returns a list of PaymentMethods for a given Customer
OptionalFieldsCustomerAddress
RetrieveCustomer
Retrieves a Customer object.
RetrieveCustomerReturnedBuilder
RetrievePaymentMethodCustomer
Retrieves a PaymentMethod object for a given Customer.
SearchCustomer
Search for customers you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating. conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up. to an hour behind during outages. Search functionality is not available to merchants in India.
UpdateCustomer
Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
UpdateCustomerCashBalance
Balance information and default balance settings for this customer.
UpdateCustomerCashBalanceSettings
Settings controlling the behavior of the customer’s cash balance, such as reconciliation of funds received.
UpdateCustomerInvoiceSettings
Default invoice settings for this customer.
UpdateCustomerInvoiceSettingsRenderingOptions
Default options for invoice PDF rendering for this customer.
UpdateCustomerTax
Tax details about the customer.

Enums§

CreateCustomerCashBalanceSettingsReconciliationMode
Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are automatic, manual, or merchant_default. For more information about these reconciliation modes, see Reconciliation.
CreateCustomerInvoiceSettingsRenderingOptionsAmountTaxDisplay
How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
CreateCustomerTaxIdDataType
Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, gb_vat, ge_vat, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin.
CreateCustomerTaxValidateLocation
A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred.
CreateFundingInstructionsCustomerBankTransferRequestedAddressTypes
List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
CreateFundingInstructionsCustomerBankTransferType
The type of the bank_transfer
CreateFundingInstructionsCustomerFundingType
The funding_type to get the instructions for.
ListPaymentMethodsCustomerAllowRedisplay
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
ListPaymentMethodsCustomerType
An optional filter on the list, based on the object type field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
RetrieveCustomerReturned
UpdateCustomerCashBalanceSettingsReconciliationMode
Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are automatic, manual, or merchant_default. For more information about these reconciliation modes, see Reconciliation.
UpdateCustomerInvoiceSettingsRenderingOptionsAmountTaxDisplay
How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
UpdateCustomerTaxValidateLocation
A flag that indicates when Stripe should validate the customer tax location. Defaults to auto.