Class: Stripe::Account::UpdateParams::Settings::Payouts::Schedule

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/account.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(delay_days: nil, interval: nil, monthly_anchor: nil, monthly_payout_days: nil, weekly_anchor: nil, weekly_payout_days: nil) ⇒ Schedule

Returns a new instance of Schedule.



2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
 
# File 'lib/stripe/resources/account.rb', line 2436

def initialize(
  delay_days: nil,
  interval: nil,
  monthly_anchor: nil,
  monthly_payout_days: nil,
  weekly_anchor: nil,
  weekly_payout_days: nil
)
  @delay_days = delay_days
  @interval = interval
  @monthly_anchor = monthly_anchor
  @monthly_payout_days = monthly_payout_days
  @weekly_anchor = weekly_anchor
  @weekly_payout_days = weekly_payout_days
end

Instance Attribute Details

#delay_days ⇒ Object

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](/connect/manage-payout-schedule).



2424
2425
2426
 
# File 'lib/stripe/resources/account.rb', line 2424

def delay_days
  @delay_days
end

#interval ⇒ Object

How frequently available funds are paid out. One of: ‘daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.



2426
2427
2428
 
# File 'lib/stripe/resources/account.rb', line 2426

def interval
  @interval
end

#monthly_anchor ⇒ Object

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`.



2428
2429
2430
 
# File 'lib/stripe/resources/account.rb', line 2428

def monthly_anchor
  @monthly_anchor
end

#monthly_payout_days ⇒ Object

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.



2430
2431
2432
 
# File 'lib/stripe/resources/account.rb', line 2430

def monthly_payout_days
  @monthly_payout_days
end

#weekly_anchor ⇒ Object

The day of the week when available funds are paid out, specified as ‘monday`, `tuesday`, etc. (required and applicable only if `interval` is `weekly`.)



2432
2433
2434
 
# File 'lib/stripe/resources/account.rb', line 2432

def weekly_anchor
  @weekly_anchor
end

#weekly_payout_days ⇒ Object

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` and `weekly_anchor` is not set.)



2434
2435
2436
 
# File 'lib/stripe/resources/account.rb', line 2434

def weekly_payout_days
  @weekly_payout_days
end