Stripe.CountrySpec (stripity_stripe_fb v2.13.1) View Source

Work with the Stripe country specs API.

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

Link to this section Summary

Types

t()

Functions

list(params \\ %{}, opts \\ [])

List all country specs.

retrieve(id, opts \\ [])

Retrieve a country spec.

Link to this section Types

t()

Specs

t() :: %Stripe.CountrySpec{
  default_currency: String.t(),
  id: Stripe.id(),
  object: String.t(),
  supported_bank_account_currencies: %{required(String.t()) => [String.t()]},
  supported_payment_currencies: [String.t()],
  supported_payment_methods: [Stripe.Source.source_type() | String.t()],
  supported_transfer_countries: [String.t()],
  verification_fields: %{
    individual: %{minimum: [String.t()], additional: [String.t()]},
    company: %{minimum: [String.t()], additional: [String.t()]}
  }
}

Link to this section Functions

list(params \\ %{}, opts \\ [])

Specs

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

List all country specs.

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a country spec.