Class: Stripe::CustomerUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/customer_update_params.rb

Defined Under Namespace

Classes: Address, CashBalance, InvoiceSettings, Shipping, Tax

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(address: nil, balance: nil, business_name: nil, cash_balance: nil, default_source: nil, description: nil, email: nil, expand: nil, individual_name: nil, invoice_prefix: nil, invoice_settings: nil, metadata: nil, name: nil, next_invoice_sequence: nil, phone: nil, preferred_locales: nil, shipping: nil, source: nil, tax: nil, tax_exempt: nil, validate: nil) ⇒ CustomerUpdateParams

Returns a new instance of CustomerUpdateParams.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/stripe/params/customer_update_params.rb', line 197

def initialize(
  address: nil,
  balance: nil,
  business_name: nil,
  cash_balance: nil,
  default_source: nil,
  description: nil,
  email: nil,
  expand: nil,
  individual_name: nil,
  invoice_prefix: nil,
  invoice_settings: nil,
  metadata: nil,
  name: nil,
  next_invoice_sequence: nil,
  phone: nil,
  preferred_locales: nil,
  shipping: nil,
  source: nil,
  tax: nil,
  tax_exempt: nil,
  validate: nil
)
  @address = address
  @balance = balance
  @business_name = business_name
  @cash_balance = cash_balance
  @default_source = default_source
  @description = description
  @email = email
  @expand = expand
  @individual_name = individual_name
  @invoice_prefix = invoice_prefix
  @invoice_settings = invoice_settings
  @metadata = metadata
  @name = name
  @next_invoice_sequence = next_invoice_sequence
  @phone = phone
  @preferred_locales = preferred_locales
  @shipping = shipping
  @source = source
  @tax = tax
  @tax_exempt = tax_exempt
  @validate = validate
end

Instance Attribute Details

#address ⇒ Object

The customer’s address.



151
152
153
 
# File 'lib/stripe/params/customer_update_params.rb', line 151

def address
  @address
end

#balance ⇒ Object

An integer amount in cents (or local equivalent) 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.



153
154
155
 
# File 'lib/stripe/params/customer_update_params.rb', line 153

def balance
  @balance
end

#business_name ⇒ Object

The customer’s business name. This may be up to *150 characters*.



155
156
157
 
# File 'lib/stripe/params/customer_update_params.rb', line 155

def business_name
  @business_name
end

#cash_balance ⇒ Object

Balance information and default balance settings for this customer.



157
158
159
 
# File 'lib/stripe/params/customer_update_params.rb', line 157

def cash_balance
  @cash_balance
end

#default_source ⇒ Object

If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.

Provide the ID of a payment source already attached to this customer to make it this customer’s default payment source.

If you want to add a new payment source and make it the default, see the [source](stripe.com/docs/api/customers/update#update_customer-source) property.



163
164
165
 
# File 'lib/stripe/params/customer_update_params.rb', line 163

def default_source
  @default_source
end

#description ⇒ Object

An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.



165
166
167
 
# File 'lib/stripe/params/customer_update_params.rb', line 165

def description
  @description
end

#email ⇒ Object

Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.



167
168
169
 
# File 'lib/stripe/params/customer_update_params.rb', line 167

def email
  @email
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



169
170
171
 
# File 'lib/stripe/params/customer_update_params.rb', line 169

def expand
  @expand
end

#individual_name ⇒ Object

The customer’s full name. This may be up to *150 characters*.



171
172
173
 
# File 'lib/stripe/params/customer_update_params.rb', line 171

def individual_name
  @individual_name
end

#invoice_prefix ⇒ Object

The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.



173
174
175
 
# File 'lib/stripe/params/customer_update_params.rb', line 173

def invoice_prefix
  @invoice_prefix
end

#invoice_settings ⇒ Object

Default invoice settings for this customer.



175
176
177
 
# File 'lib/stripe/params/customer_update_params.rb', line 175

def invoice_settings
  @invoice_settings
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



177
178
179
 
# File 'lib/stripe/params/customer_update_params.rb', line 177

def metadata
  @metadata
end

#name ⇒ Object

The customer’s full name or business name.



179
180
181
 
# File 'lib/stripe/params/customer_update_params.rb', line 179

def name
  @name
end

#next_invoice_sequence ⇒ Object

The sequence to be used on the customer’s next invoice. Defaults to 1.



181
182
183
 
# File 'lib/stripe/params/customer_update_params.rb', line 181

def next_invoice_sequence
  @next_invoice_sequence
end

#phone ⇒ Object

The customer’s phone number.



183
184
185
 
# File 'lib/stripe/params/customer_update_params.rb', line 183

def phone
  @phone
end

#preferred_locales ⇒ Object

Customer’s preferred languages, ordered by preference.



185
186
187
 
# File 'lib/stripe/params/customer_update_params.rb', line 185

def preferred_locales
  @preferred_locales
end

#shipping ⇒ Object

The customer’s shipping information. Appears on invoices emailed to this customer.



187
188
189
 
# File 'lib/stripe/params/customer_update_params.rb', line 187

def shipping
  @shipping
end

#source ⇒ Object

Attribute for param field source



189
190
191
 
# File 'lib/stripe/params/customer_update_params.rb', line 189

def source
  @source
end

#tax ⇒ Object

Tax details about the customer.



191
192
193
 
# File 'lib/stripe/params/customer_update_params.rb', line 191

def tax
  @tax
end

#tax_exempt ⇒ Object

The customer’s tax exemption. One of ‘none`, `exempt`, or `reverse`.



193
194
195
 
# File 'lib/stripe/params/customer_update_params.rb', line 193

def tax_exempt
  @tax_exempt
end

#validate ⇒ Object

Attribute for param field validate



195
196
197
 
# File 'lib/stripe/params/customer_update_params.rb', line 195

def validate
  @validate
end