Class: Stripe::Customer::CreateParams

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

Defined Under Namespace

Classes: Address, CashBalance, InvoiceSettings, Shipping, Tax, TaxIdDatum

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(address: nil, balance: nil, cash_balance: nil, description: nil, email: nil, expand: nil, invoice_prefix: nil, invoice_settings: nil, metadata: nil, name: nil, next_invoice_sequence: nil, payment_method: nil, phone: nil, preferred_locales: nil, shipping: nil, source: nil, tax: nil, tax_exempt: nil, tax_id_data: nil, test_clock: nil, validate: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/stripe/resources/customer.rb', line 609

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

Instance Attribute Details

#address ⇒ Object

The customer’s address.



567
568
569
 
# File 'lib/stripe/resources/customer.rb', line 567

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.



569
570
571
 
# File 'lib/stripe/resources/customer.rb', line 569

def balance
  @balance
end

#cash_balance ⇒ Object

Balance information and default balance settings for this customer.



571
572
573
 
# File 'lib/stripe/resources/customer.rb', line 571

def cash_balance
  @cash_balance
end

#description ⇒ Object

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



573
574
575
 
# File 'lib/stripe/resources/customer.rb', line 573

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



575
576
577
 
# File 'lib/stripe/resources/customer.rb', line 575

def email
  @email
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



577
578
579
 
# File 'lib/stripe/resources/customer.rb', line 577

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.



579
580
581
 
# File 'lib/stripe/resources/customer.rb', line 579

def invoice_prefix
  @invoice_prefix
end

#invoice_settings ⇒ Object

Default invoice settings for this customer.



581
582
583
 
# File 'lib/stripe/resources/customer.rb', line 581

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



583
584
585
 
# File 'lib/stripe/resources/customer.rb', line 583

def metadata
  @metadata
end

#name ⇒ Object

The customer’s full name or business name.



585
586
587
 
# File 'lib/stripe/resources/customer.rb', line 585

def name
  @name
end

#next_invoice_sequence ⇒ Object

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



587
588
589
 
# File 'lib/stripe/resources/customer.rb', line 587

def next_invoice_sequence
  @next_invoice_sequence
end

#payment_method ⇒ Object

Attribute for param field payment_method



589
590
591
 
# File 'lib/stripe/resources/customer.rb', line 589

def payment_method
  @payment_method
end

#phone ⇒ Object

The customer’s phone number.



591
592
593
 
# File 'lib/stripe/resources/customer.rb', line 591

def phone
  @phone
end

#preferred_locales ⇒ Object

Customer’s preferred languages, ordered by preference.



593
594
595
 
# File 'lib/stripe/resources/customer.rb', line 593

def preferred_locales
  @preferred_locales
end

#shipping ⇒ Object

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



595
596
597
 
# File 'lib/stripe/resources/customer.rb', line 595

def shipping
  @shipping
end

#source ⇒ Object

Attribute for param field source



597
598
599
 
# File 'lib/stripe/resources/customer.rb', line 597

def source
  @source
end

#tax ⇒ Object

Tax details about the customer.



599
600
601
 
# File 'lib/stripe/resources/customer.rb', line 599

def tax
  @tax
end

#tax_exempt ⇒ Object

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



601
602
603
 
# File 'lib/stripe/resources/customer.rb', line 601

def tax_exempt
  @tax_exempt
end

#tax_id_data ⇒ Object

The customer’s tax IDs.



603
604
605
 
# File 'lib/stripe/resources/customer.rb', line 603

def tax_id_data
  @tax_id_data
end

#test_clock ⇒ Object

ID of the test clock to attach to the customer.



605
606
607
 
# File 'lib/stripe/resources/customer.rb', line 605

def test_clock
  @test_clock
end

#validate ⇒ Object

Attribute for param field validate



607
608
609
 
# File 'lib/stripe/resources/customer.rb', line 607

def validate
  @validate
end