View Source Stripe.BalanceSettings (stripity_stripe v3.3.1)

Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.

Summary

Types

payments()

Settings that apply to the Payments Balance.

payouts()

Settings specific to the account's payouts.

schedule()

Details on when funds from charges are available, and when they are paid out to an external account. For details, see our Setting Bank and Debit Card Payouts documentation.

settlement_timing()

Settings related to the account's balance settlement timing.

t()

The balance_settings type.

Functions

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

Retrieves balance settings for a given connected account. Related guide: Making API calls for connected accounts

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

Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts

Types

payments()

@type payments() :: %{
  optional(:debit_negative_balances) => boolean(),
  optional(:payouts) => payouts(),
  optional(:settlement_timing) => settlement_timing()
}

Settings that apply to the Payments Balance.

payouts()

@type payouts() :: %{
  optional(:minimum_balance_by_currency) => map() | binary(),
  optional(:schedule) => schedule(),
  optional(:statement_descriptor) => binary()
}

Settings specific to the account's payouts.

schedule()

@type schedule() :: %{
  optional(:interval) => :daily | :manual | :monthly | :weekly,
  optional(:monthly_payout_days) => [integer()],
  optional(:weekly_payout_days) => [
    :friday | :monday | :thursday | :tuesday | :wednesday
  ]
}

Details on when funds from charges are available, and when they are paid out to an external account. For details, see our Setting Bank and Debit Card Payouts documentation.

settlement_timing()

@type settlement_timing() :: %{optional(:delay_days_override) => integer() | binary()}

Settings related to the account's balance settlement timing.

t()

@type t() :: %Stripe.BalanceSettings{object: binary(), payments: term()}

The balance_settings type.

object String representing the object's type. Objects of the same type share the same value.
payments

Functions

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

@spec retrieve(params :: %{optional(:expand) => [binary()]}, opts :: Keyword.t()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves balance settings for a given connected account. Related guide: Making API calls for connected accounts

#### Details * Method: `get` * Path: `/v1/balance_settings`

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

@spec update(
  params :: %{
    optional(:expand) => [binary()],
    optional(:payments) => payments()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts

#### Details * Method: `post` * Path: `/v1/balance_settings`