Class: Stripe::Customer::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/customer.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, cash_balance: nil, default_source: nil, description: nil, email: nil, expand: 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) ⇒ UpdateParams

Returns a new instance of UpdateParams.



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/stripe/resources/customer.rb', line 306

def initialize(
  address: nil,
  balance: nil,
  cash_balance: nil,
  default_source: nil,
  description: nil,
  email: nil,
  expand: 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
  @cash_balance = cash_balance
  @default_source = default_source
  @description = description
  @email = email
  @expand = expand
  @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.



264
265
266
 
# File 'lib/stripe/resources/customer.rb', line 264

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.



266
267
268
 
# File 'lib/stripe/resources/customer.rb', line 266

def balance
  @balance
end

#cash_balance ⇒ Object

Balance information and default balance settings for this customer.



268
269
270
 
# File 'lib/stripe/resources/customer.rb', line 268

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.



274
275
276
 
# File 'lib/stripe/resources/customer.rb', line 274

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.



276
277
278
 
# File 'lib/stripe/resources/customer.rb', line 276

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*.



278
279
280
 
# File 'lib/stripe/resources/customer.rb', line 278

def email
  @email
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



280
281
282
 
# File 'lib/stripe/resources/customer.rb', line 280

def expand
  @expand
end

#invoice_prefix ⇒ Object

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



282
283
284
 
# File 'lib/stripe/resources/customer.rb', line 282

def invoice_prefix
  @invoice_prefix
end

#invoice_settings ⇒ Object

Default invoice settings for this customer.



284
285
286
 
# File 'lib/stripe/resources/customer.rb', line 284

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`.



286
287
288
 
# File 'lib/stripe/resources/customer.rb', line 286

def metadata
  @metadata
end

#name ⇒ Object

The customer’s full name or business name.



288
289
290
 
# File 'lib/stripe/resources/customer.rb', line 288

def name
  @name
end

#next_invoice_sequence ⇒ Object

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



290
291
292
 
# File 'lib/stripe/resources/customer.rb', line 290

def next_invoice_sequence
  @next_invoice_sequence
end

#phone ⇒ Object

The customer’s phone number.



292
293
294
 
# File 'lib/stripe/resources/customer.rb', line 292

def phone
  @phone
end

#preferred_locales ⇒ Object

Customer’s preferred languages, ordered by preference.



294
295
296
 
# File 'lib/stripe/resources/customer.rb', line 294

def preferred_locales
  @preferred_locales
end

#shipping ⇒ Object

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



296
297
298
 
# File 'lib/stripe/resources/customer.rb', line 296

def shipping
  @shipping
end

#source ⇒ Object

Attribute for param field source



298
299
300
 
# File 'lib/stripe/resources/customer.rb', line 298

def source
  @source
end

#tax ⇒ Object

Tax details about the customer.



300
301
302
 
# File 'lib/stripe/resources/customer.rb', line 300

def tax
  @tax
end

#tax_exempt ⇒ Object

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



302
303
304
 
# File 'lib/stripe/resources/customer.rb', line 302

def tax_exempt
  @tax_exempt
end

#validate ⇒ Object

Attribute for param field validate



304
305
306
 
# File 'lib/stripe/resources/customer.rb', line 304

def validate
  @validate
end