stripity_stripe

stripity_stripe v2.7.0 Stripe.Person View Source

Work with Stripe Connect person objects.

You can:

  • Create a person
  • Retrieve a person with a specified id
  • Update a person
  • Delete a person
  • List all persons on an account

Stripe API reference: https://stripe.com/docs/api/persons

Link to this section Summary

Types

create_params()
relationship()
requirements()
t()
update_params()
verification()
verification_document()

Functions

create(params, opts \\ [])

Create a person.

delete(id, params, opts \\ [])

Delete a person.

list(params, opts \\ [])

List all persons on an account.

retrieve(id, params, opts \\ [])

Retrieve a person with a specified id.

update(id, params, opts \\ [])

Update a person.

Link to this section Types

Link to this type

create_params() View Source 
create_params() :: %{
  optional(:account) => String.t(),
  optional(:address) => Stripe.Types.address(),
  optional(:address_kana) => Stripe.Types.japan_address(),
  optional(:address_kanji) => Stripe.Types.japan_address(),
  optional(:dob) => Stripe.Types.dob(),
  optional(:email) => String.t(),
  optional(:first_name) => String.t(),
  optional(:first_name_kana) => String.t(),
  optional(:first_name_kanji) => String.t(),
  optional(:gender) => String.t(),
  optional(:id_number) => String.t(),
  optional(:last_name) => String.t(),
  optional(:last_name_kana) => String.t(),
  optional(:last_name_kanji) => String.t(),
  optional(:maiden_name) => String.t(),
  optional(:metadata) => Stripe.Types.metadata(),
  optional(:person_token) => String.t(),
  optional(:phone) => String.t(),
  optional(:relationship) => relationship(),
  optional(:ssn_last_4) => String.t(),
  optional(:verification) => verification()
}

Link to this type

relationship() View Source 
relationship() :: %{
  account_opener: boolean() | nil,
  director: boolean() | nil,
  owner: boolean() | nil,
  percent_ownership: float() | nil,
  title: String.t() | nil
}

Link to this type

requirements() View Source 
requirements() :: %{
  currently_due: Stripe.List.t(String.t()) | nil,
  eventually_due: Stripe.List.t(String.t()) | nil,
  past_due: Stripe.List.t(String.t()) | nil
}

Link to this type

t() View Source 
t() :: %Stripe.Person{
  account: Stripe.id(),
  address: Stripe.Types.address() | nil,
  address_kana: Stripe.Types.japan_address() | nil,
  address_kanji: Stripe.Types.japan_address() | nil,
  created: Stripe.timestamp() | nil,
  dob: Stripe.Types.dob() | nil,
  email: String.t() | nil,
  first_name: String.t() | nil,
  first_name_kana: String.t() | nil,
  first_name_kanji: String.t() | nil,
  gender: String.t() | nil,
  id: Stripe.id(),
  id_number_provided: boolean(),
  last_name: String.t() | nil,
  last_name_kana: String.t() | nil,
  last_name_kanji: String.t() | nil,
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  phone: String.t() | nil,
  relationship: relationship() | nil,
  requirements: requirements() | nil,
  ssn_last_4_provided: boolean(),
  verification: verification() | nil
}

Link to this type

update_params() View Source 
update_params() :: %{
  optional(:account) => String.t(),
  optional(:address) => Stripe.Types.address(),
  optional(:address_kana) => Stripe.Types.japan_address(),
  optional(:address_kanji) => Stripe.Types.japan_address(),
  optional(:dob) => Stripe.Types.dob(),
  optional(:email) => String.t(),
  optional(:first_name) => String.t(),
  optional(:first_name_kana) => String.t(),
  optional(:first_name_kanji) => String.t(),
  optional(:gender) => String.t(),
  optional(:id_number) => String.t(),
  optional(:last_name) => String.t(),
  optional(:last_name_kana) => String.t(),
  optional(:last_name_kanji) => String.t(),
  optional(:maiden_name) => String.t(),
  optional(:metadata) => Stripe.Types.metadata(),
  optional(:person_token) => String.t(),
  optional(:phone) => String.t(),
  optional(:relationship) => relationship(),
  optional(:ssn_last_4) => String.t(),
  optional(:verification) => verification()
}

Link to this type

verification() View Source 
verification() :: %{
  details: String.t() | nil,
  details_code: String.t() | nil,
  document: verification_document() | nil,
  status: String.t() | nil
}

Link to this type

verification_document() View Source 
verification_document() :: %{
  back: String.t() | nil,
  details: String.t() | nil,
  details_code: String.t() | nil,
  front: String.t() | nil
}

Link to this section Functions

Link to this function

create(params, opts \\ []) View Source 
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: create_params()

Create a person.

Link to this function

delete(id, params, opts \\ []) View Source 
delete(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{account: Stripe.id()}

Delete a person.

Link to this function

list(params, opts \\ []) View Source 
list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       :account => Stripe.id(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

List all persons on an account.

Link to this function

retrieve(id, params, opts \\ []) View Source

Retrieve a person with a specified id.

Link to this function

update(id, params, opts \\ []) View Source 
update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: update_params()

Update a person.

Takes the id and a map of changes.

Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/ or s
Focus search bar
?
Bring up this help dialog