Stripe.Params.AccountUpdateParams.Settings.Payouts.Schedule (tiger_stripe v0.1.10)

Copy Markdown View Source

Nested parameters.

Summary

Types

t()

Types

t()

@type t() :: %Stripe.Params.AccountUpdateParams.Settings.Payouts.Schedule{
  delay_days: map() | nil,
  interval: String.t() | nil,
  monthly_anchor: integer() | nil,
  monthly_payout_days: [integer()] | nil,
  weekly_anchor: String.t() | nil,
  weekly_payout_days: [String.t()] | nil
}
  • delay_days - The number of days charge funds are held before being paid out. May also be set to minimum, representing the lowest available value for the account country. Default is minimum. The delay_days parameter remains at the last configured value if interval is manual. Learn more about controlling payout delay days.
  • interval - How frequently available funds are paid out. One of: daily, manual, weekly, or monthly. Default is daily. Possible values: daily, manual, monthly, weekly. Max length: 5000.
  • monthly_anchor - The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if interval is monthly.
  • monthly_payout_days - The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if interval is monthly and monthly_anchor is not set.
  • weekly_anchor - The day of the week when available funds are paid out, specified as monday, tuesday, etc. Required and applicable only if interval is weekly. Possible values: friday, monday, saturday, sunday, thursday, tuesday, wednesday. Max length: 5000.
  • weekly_payout_days - The days of the week when available funds are paid out, specified as an array, e.g., [monday, tuesday]. Required and applicable only if interval is weekly.