Stripe.Types (stripity_stripe v2.17.2) View Source

A module that contains shared types matching Stripe schemas.

Link to this section Summary

Link to this section Types

Specs

address() :: %{
  city: String.t() | nil,
  country: String.t() | nil,
  line1: String.t() | nil,
  line2: String.t() | nil,
  postal_code: String.t() | nil,
  state: String.t() | nil
}
Link to this type

collection_method_thresholds()

View Source

Specs

collection_method_thresholds() :: %{
  amount_gte: integer() | nil,
  reset_billing_cycle_anchor: boolean() | nil
}

Specs

dob() :: %{day: 1..31 | nil, month: 1..12 | nil, year: pos_integer() | nil}

Specs

fee() :: %{
  amount: integer(),
  application: String.t() | nil,
  currency: String.t(),
  description: String.t() | nil,
  type: String.t()
}

Specs

japan_address() :: %{
  city: String.t() | nil,
  country: String.t() | nil,
  line1: String.t() | nil,
  line2: String.t() | nil,
  postal_code: String.t() | nil,
  state: String.t() | nil,
  town: String.t() | nil
}

Specs

metadata() :: %{optional(String.t()) => String.t()}

Specs

shipping() :: %{
  address: address(),
  carrier: String.t() | nil,
  eta: Stripe.timestamp() | nil,
  name: String.t(),
  phone: String.t() | nil,
  status: String.t() | nil,
  tracking_number: String.t() | nil,
  tracking_url: String.t() | nil
}

Specs

transfer_schedule() :: %{
  delay_days: non_neg_integer(),
  interval: String.t(),
  monthly_anchor: non_neg_integer() | nil,
  weekly_anchor: String.t() | nil
}