Class: Stripe::Issuing::Cardholder::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/issuing/cardholder.rb

Defined Under Namespace

Classes: Billing, Company, Individual, SpendingControls

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(billing: nil, company: nil, email: nil, expand: nil, individual: nil, metadata: nil, name: nil, phone_number: nil, preferred_locales: nil, spending_controls: nil, status: nil, type: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 478

def initialize(
  billing: nil,
  company: nil,
  email: nil,
  expand: nil,
  individual: nil,
  metadata: nil,
  name: nil,
  phone_number: nil,
  preferred_locales: nil,
  spending_controls: nil,
  status: nil,
  type: nil
)
  @billing = billing
  @company = company
  @email = email
  @expand = expand
  @individual = individual
  @metadata = metadata
  @name = name
  @phone_number = phone_number
  @preferred_locales = preferred_locales
  @spending_controls = spending_controls
  @status = status
  @type = type
end

Instance Attribute Details

#billing ⇒ Object

The cardholder’s billing address.



452
453
454
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 452

def billing
  @billing
end

#company ⇒ Object

Additional information about a ‘company` cardholder.



454
455
456
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 454

def company
  @company
end

#email ⇒ Object

The cardholder’s email address.



456
457
458
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 456

def email
  @email
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



458
459
460
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 458

def expand
  @expand
end

#individual ⇒ Object

Additional information about an ‘individual` cardholder.



460
461
462
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 460

def individual
  @individual
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`.



462
463
464
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 462

def metadata
  @metadata
end

#name ⇒ Object

The cardholder’s name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.



464
465
466
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 464

def name
  @name
end

#phone_number ⇒ Object

The cardholder’s phone number. This will be transformed to [E.164](en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.

While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.



467
468
469
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 467

def phone_number
  @phone_number
end

#preferred_locales ⇒ Object

The cardholder’s preferred locales (languages), ordered by preference. Locales can be ‘de`, `en`, `es`, `fr`, or `it`.

This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.



470
471
472
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 470

def preferred_locales
  @preferred_locales
end

#spending_controls ⇒ Object

Rules that control spending across this cardholder’s cards. Refer to our [documentation](stripe.com/docs/issuing/controls/spending-controls) for more details.



472
473
474
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 472

def spending_controls
  @spending_controls
end

#status ⇒ Object

Specifies whether to permit authorizations on this cardholder’s cards. Defaults to ‘active`.



474
475
476
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 474

def status
  @status
end

#type ⇒ Object

One of ‘individual` or `company`. See [Choose a cardholder type](stripe.com/docs/issuing/other/choose-cardholder) for more details.



476
477
478
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 476

def type
  @type
end