Class: Stripe::AccountService::UpdateParams::Company

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/account_service.rb

Defined Under Namespace

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#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_number: nil, structure: nil, tax_id: nil, tax_id_registrar: nil, vat_id: nil, verification: nil) ⇒ Company

Returns a new instance of Company.



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/stripe/services/account_service.rb', line 1195

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_number: 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_number = registration_number
  @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.



1153
1154
1155
 
# File 'lib/stripe/services/account_service.rb', line 1153

def address
  @address
end

#address_kana ⇒ Object

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



1155
1156
1157
 
# File 'lib/stripe/services/account_service.rb', line 1155

def address_kana
  @address_kana
end

#address_kanji ⇒ Object

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



1157
1158
1159
 
# File 'lib/stripe/services/account_service.rb', line 1157

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.



1159
1160
1161
 
# File 'lib/stripe/services/account_service.rb', line 1159

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.



1161
1162
1163
 
# File 'lib/stripe/services/account_service.rb', line 1161

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.



1163
1164
1165
 
# File 'lib/stripe/services/account_service.rb', line 1163

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



1165
1166
1167
 
# File 'lib/stripe/services/account_service.rb', line 1165

def export_license_id
  @export_license_id
end

#export_purpose_code ⇒ Object

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



1167
1168
1169
 
# File 'lib/stripe/services/account_service.rb', line 1167

def export_purpose_code
  @export_purpose_code
end

#name ⇒ Object

The company’s legal name.



1169
1170
1171
 
# File 'lib/stripe/services/account_service.rb', line 1169

def name
  @name
end

#name_kana ⇒ Object

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



1171
1172
1173
 
# File 'lib/stripe/services/account_service.rb', line 1171

def name_kana
  @name_kana
end

#name_kanji ⇒ Object

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



1173
1174
1175
 
# File 'lib/stripe/services/account_service.rb', line 1173

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.



1175
1176
1177
 
# File 'lib/stripe/services/account_service.rb', line 1175

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.



1177
1178
1179
 
# File 'lib/stripe/services/account_service.rb', line 1177

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.



1179
1180
1181
 
# File 'lib/stripe/services/account_service.rb', line 1179

def ownership_exemption_reason
  @ownership_exemption_reason
end

#phone ⇒ Object

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



1181
1182
1183
 
# File 'lib/stripe/services/account_service.rb', line 1181

def phone
  @phone
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).



1183
1184
1185
 
# File 'lib/stripe/services/account_service.rb', line 1183

def registration_number
  @registration_number
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.



1185
1186
1187
 
# File 'lib/stripe/services/account_service.rb', line 1185

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



1187
1188
1189
 
# File 'lib/stripe/services/account_service.rb', line 1187

def tax_id
  @tax_id
end

#tax_id_registrar ⇒ Object

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



1189
1190
1191
 
# File 'lib/stripe/services/account_service.rb', line 1189

def tax_id_registrar
  @tax_id_registrar
end

#vat_id ⇒ Object

The VAT number of the company.



1191
1192
1193
 
# File 'lib/stripe/services/account_service.rb', line 1191

def vat_id
  @vat_id
end

#verification ⇒ Object

Information on the verification state of the company.



1193
1194
1195
 
# File 'lib/stripe/services/account_service.rb', line 1193

def verification
  @verification
end