Class: Stripe::AccountUpdateParams::Company

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

Defined Under Namespace

Classes: Address, AddressKana, AddressKanji, DirectorshipDeclaration, OwnershipDeclaration, RegistrationDate, RepresentativeDeclaration, Verification

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(address: nil, address_kana: nil, address_kanji: nil, directors_provided: nil, directorship_declaration: nil, executives_provided: nil, export_license_id: nil, export_purpose_code: nil, name: nil, name_kana: nil, name_kanji: nil, owners_provided: nil, ownership_declaration: nil, ownership_exemption_reason: nil, phone: nil, registration_date: nil, registration_number: nil, representative_declaration: nil, structure: nil, tax_id: nil, tax_id_registrar: nil, vat_id: nil, verification: nil) ⇒ Company

Returns a new instance of Company.



1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'lib/stripe/params/account_update_params.rb', line 1493

def initialize(
  address: nil,
  address_kana: nil,
  address_kanji: nil,
  directors_provided: nil,
  directorship_declaration: nil,
  executives_provided: nil,
  export_license_id: nil,
  export_purpose_code: nil,
  name: nil,
  name_kana: nil,
  name_kanji: nil,
  owners_provided: nil,
  ownership_declaration: nil,
  ownership_exemption_reason: nil,
  phone: nil,
  registration_date: nil,
  registration_number: nil,
  representative_declaration: nil,
  structure: nil,
  tax_id: nil,
  tax_id_registrar: nil,
  vat_id: nil,
  verification: nil
)
  @address = address
  @address_kana = address_kana
  @address_kanji = address_kanji
  @directors_provided = directors_provided
  @directorship_declaration = directorship_declaration
  @executives_provided = executives_provided
  @export_license_id = export_license_id
  @export_purpose_code = export_purpose_code
  @name = name
  @name_kana = name_kana
  @name_kanji = name_kanji
  @owners_provided = owners_provided
  @ownership_declaration = ownership_declaration
  @ownership_exemption_reason = ownership_exemption_reason
  @phone = phone
  @registration_date = registration_date
  @registration_number = registration_number
  @representative_declaration = representative_declaration
  @structure = structure
  @tax_id = tax_id
  @tax_id_registrar = tax_id_registrar
  @vat_id = vat_id
  @verification = verification
end

Instance Attribute Details

#address ⇒ Object

The company’s primary address.



1447
1448
1449
 
# File 'lib/stripe/params/account_update_params.rb', line 1447

def address
  @address
end

#address_kana ⇒ Object

The Kana variation of the company’s primary address (Japan only).



1449
1450
1451
 
# File 'lib/stripe/params/account_update_params.rb', line 1449

def address_kana
  @address_kana
end

#address_kanji ⇒ Object

The Kanji variation of the company’s primary address (Japan only).



1451
1452
1453
 
# File 'lib/stripe/params/account_update_params.rb', line 1451

def address_kanji
  @address_kanji
end

#directors_provided ⇒ Object

Whether the company’s directors have been provided. Set this Boolean to ‘true` after creating all the company’s directors with [the Persons API](/api/persons) for accounts with a ‘relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.



1453
1454
1455
 
# File 'lib/stripe/params/account_update_params.rb', line 1453

def directors_provided
  @directors_provided
end

#directorship_declaration ⇒ Object

This hash is used to attest that the directors information provided to Stripe is both current and correct.



1455
1456
1457
 
# File 'lib/stripe/params/account_update_params.rb', line 1455

def directorship_declaration
  @directorship_declaration
end

#executives_provided ⇒ Object

Whether the company’s executives have been provided. Set this Boolean to ‘true` after creating all the company’s executives with [the Persons API](/api/persons) for accounts with a ‘relationship.executive` requirement.



1457
1458
1459
 
# File 'lib/stripe/params/account_update_params.rb', line 1457

def executives_provided
  @executives_provided
end

#export_license_id ⇒ Object

The export license ID number of the company, also referred as Import Export Code (India only).



1459
1460
1461
 
# File 'lib/stripe/params/account_update_params.rb', line 1459

def export_license_id
  @export_license_id
end

#export_purpose_code ⇒ Object

The purpose code to use for export transactions (India only).



1461
1462
1463
 
# File 'lib/stripe/params/account_update_params.rb', line 1461

def export_purpose_code
  @export_purpose_code
end

#name ⇒ Object

The company’s legal name.



1463
1464
1465
 
# File 'lib/stripe/params/account_update_params.rb', line 1463

def name
  @name
end

#name_kana ⇒ Object

The Kana variation of the company’s legal name (Japan only).



1465
1466
1467
 
# File 'lib/stripe/params/account_update_params.rb', line 1465

def name_kana
  @name_kana
end

#name_kanji ⇒ Object

The Kanji variation of the company’s legal name (Japan only).



1467
1468
1469
 
# File 'lib/stripe/params/account_update_params.rb', line 1467

def name_kanji
  @name_kanji
end

#owners_provided ⇒ Object

Whether the company’s owners have been provided. Set this Boolean to ‘true` after creating all the company’s owners with [the Persons API](/api/persons) for accounts with a ‘relationship.owner` requirement.



1469
1470
1471
 
# File 'lib/stripe/params/account_update_params.rb', line 1469

def owners_provided
  @owners_provided
end

#ownership_declaration ⇒ Object

This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.



1471
1472
1473
 
# File 'lib/stripe/params/account_update_params.rb', line 1471

def ownership_declaration
  @ownership_declaration
end

#ownership_exemption_reason ⇒ Object

This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.



1473
1474
1475
 
# File 'lib/stripe/params/account_update_params.rb', line 1473

def ownership_exemption_reason
  @ownership_exemption_reason
end

#phone ⇒ Object

The company’s phone number (used for verification).



1475
1476
1477
 
# File 'lib/stripe/params/account_update_params.rb', line 1475

def phone
  @phone
end

#registration_date ⇒ Object

Attribute for param field registration_date



1477
1478
1479
 
# File 'lib/stripe/params/account_update_params.rb', line 1477

def registration_date
  @registration_date
end

#registration_number ⇒ Object

The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).



1479
1480
1481
 
# File 'lib/stripe/params/account_update_params.rb', line 1479

def registration_number
  @registration_number
end

#representative_declaration ⇒ Object

This hash is used to attest that the representative is authorized to act as the representative of their legal entity.



1481
1482
1483
 
# File 'lib/stripe/params/account_update_params.rb', line 1481

def representative_declaration
  @representative_declaration
end

#structure ⇒ Object

The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.



1483
1484
1485
 
# File 'lib/stripe/params/account_update_params.rb', line 1483

def structure
  @structure
end

#tax_id ⇒ Object

The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)



1485
1486
1487
 
# File 'lib/stripe/params/account_update_params.rb', line 1485

def tax_id
  @tax_id
end

#tax_id_registrar ⇒ Object

The jurisdiction in which the ‘tax_id` is registered (Germany-based companies only).



1487
1488
1489
 
# File 'lib/stripe/params/account_update_params.rb', line 1487

def tax_id_registrar
  @tax_id_registrar
end

#vat_id ⇒ Object

The VAT number of the company.



1489
1490
1491
 
# File 'lib/stripe/params/account_update_params.rb', line 1489

def vat_id
  @vat_id
end

#verification ⇒ Object

Information on the verification state of the company.



1491
1492
1493
 
# File 'lib/stripe/params/account_update_params.rb', line 1491

def verification
  @verification
end