Class: Stripe::Issuing::Cardholder

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/issuing/cardholder.rb

Overview

An Issuing ‘Cardholder` object represents an individual or business entity who is [issued](stripe.com/docs/issuing) cards.

Related guide: [How to create a cardholder](stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder)

Defined Under Namespace

Classes: Billing, Company, CreateParams, Individual, ListParams, Requirements, RetrieveParams, SpendingControls, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"issuing.cardholder"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#billing ⇒ Object (readonly)

Attribute for field billing



739
740
741
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 739

def billing
  @billing
end

#company ⇒ Object (readonly)

Additional information about a ‘company` cardholder.



742
743
744
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 742

def company
  @company
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



745
746
747
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 745

def created
  @created
end

#email ⇒ Object (readonly)

The cardholder’s email address.



748
749
750
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 748

def email
  @email
end

#id ⇒ Object (readonly)

Unique identifier for the object.



751
752
753
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 751

def id
  @id
end

#individual ⇒ Object (readonly)

Additional information about an ‘individual` cardholder.



754
755
756
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 754

def individual
  @individual
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



757
758
759
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 757

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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.



760
761
762
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 760

def metadata
  @metadata
end

#name ⇒ Object (readonly)

The cardholder’s name. This will be printed on cards issued to them.



763
764
765
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 763

def name
  @name
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



766
767
768
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 766

def object
  @object
end

#phone_number ⇒ Object (readonly)

The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.



769
770
771
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 769

def phone_number
  @phone_number
end

#preferred_locales ⇒ Object (readonly)

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.



773
774
775
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 773

def preferred_locales
  @preferred_locales
end

#requirements ⇒ Object (readonly)

Attribute for field requirements



776
777
778
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 776

def requirements
  @requirements
end

#spending_controls ⇒ Object (readonly)

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



779
780
781
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 779

def spending_controls
  @spending_controls
end

#status ⇒ Object (readonly)

Specifies whether to permit authorizations on this cardholder’s cards.



782
783
784
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 782

def status
  @status
end

#type ⇒ Object (readonly)

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



785
786
787
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 785

def type
  @type
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a new Issuing Cardholder object that can be issued cards.



788
789
790
791
792
793
794
795
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 788

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/issuing/cardholders",
    params: params,
    opts: opts
  )
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.



798
799
800
801
802
803
804
805
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 798

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/issuing/cardholders",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



15
16
17
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 15

def self.object_name
  "issuing.cardholder"
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



808
809
810
811
812
813
814
815
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 808

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/cardholders/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end