exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.LegalEntityCompany (exoapi_stripe v0.1.4)

:address :: ExOAPI.Stripe.Schemas.Address

:address_kana :: ExOAPI.Stripe.Schemas.LegalEntityJapanAddress

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

:address_kanji :: ExOAPI.Stripe.Schemas.LegalEntityJapanAddress

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

:directors_provided :: :boolean

Whether the company's directors have been provided. This Boolean will be true if you've manually indicated that all directors are provided via the directors_provided parameter.

:executives_provided :: :boolean

Whether the company's executives have been provided. This Boolean will be true if you've manually indicated that all executives are provided via the executives_provided parameter, or if Stripe determined that sufficient executives were provided.

:name :: :string

The company's legal name.

:name_kana :: :string

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

:name_kanji :: :string

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

:owners_provided :: :boolean

Whether the company's owners have been provided. This Boolean will be true if you've manually indicated that all owners are provided via the owners_provided parameter, or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the percent_ownership of each owner together).

:ownership_declaration :: ExOAPI.Stripe.Schemas.LegalEntityUboDeclaration

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

:phone :: :string

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

:structure :: :string

The category identifying the legal structure of the company or legal entity. See Business structure for more details.

:tax_id_provided :: :boolean

Whether the company's business ID number was provided.

:tax_id_registrar :: :string

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

:vat_id_provided :: :boolean

Whether the company's business VAT number was provided.

:verification :: ExOAPI.Stripe.Schemas.LegalEntityCompanyVerification

Information on the verification state of the company.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.LegalEntityCompany{
  address: ExOAPI.Stripe.Schemas.Address.t() | nil,
  address_kana: ExOAPI.EctoTypes.AnyOf.t() | nil,
  address_kanji: ExOAPI.EctoTypes.AnyOf.t() | nil,
  directors_provided: boolean() | nil,
  executives_provided: boolean() | nil,
  name: String.t() | nil,
  name_kana: String.t() | nil,
  name_kanji: String.t() | nil,
  owners_provided: boolean() | nil,
  ownership_declaration: ExOAPI.EctoTypes.AnyOf.t() | nil,
  phone: String.t() | nil,
  structure:
    (:unincorporated_non_profit
     | :unincorporated_association
     | :tax_exempt_government_instrumentality
     | :sole_proprietorship
     | :sole_establishment
     | :single_member_llc
     | :public_partnership
     | :public_corporation
     | :public_company
     | :private_partnership
     | :private_corporation
     | :private_company
     | :multi_member_llc
     | :llc
     | :limited_liability_partnership
     | :incorporated_non_profit
     | :governmental_unit
     | :government_instrumentality
     | :free_zone_llc
     | :free_zone_establishment)
    | nil,
  tax_id_provided: boolean() | nil,
  tax_id_registrar: String.t() | nil,
  vat_id_provided: boolean() | nil,
  verification: ExOAPI.EctoTypes.AnyOf.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()