StripeAPI.Types.TransferSchedule

Contains the types generated from the schema TransferSchedule

Documentation

data TransferSchedule

Defines the object schema located at components.schemas.transfer_schedule in the specification.

Constructors

TransferSchedule

Fields

• transferScheduleDelayDays :: Int

  delay_days: The number of days charges for the account will be held before being paid out.

• transferScheduleInterval :: Text

  interval: How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.

  Constraints:

  • Maximum length of 5000
• transferScheduleMonthlyAnchor :: Maybe Int

  monthly_anchor: The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.

• transferScheduleWeeklyAnchor :: Maybe Text

  weekly_anchor: The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly.

  Constraints:

  • Maximum length of 5000

Instances

Eq TransferSchedule

Defined in StripeAPI.Types.TransferSchedule

Methods

(==) :: TransferSchedule -> TransferSchedule -> Bool

(/=) :: TransferSchedule -> TransferSchedule -> Bool

Show TransferSchedule

Defined in StripeAPI.Types.TransferSchedule

Methods

showsPrec :: Int -> TransferSchedule -> ShowS

show :: TransferSchedule -> String

showList :: [TransferSchedule] -> ShowS

ToJSON TransferSchedule

Defined in StripeAPI.Types.TransferSchedule

Methods

toJSON :: TransferSchedule -> Value

toEncoding :: TransferSchedule -> Encoding

toJSONList :: [TransferSchedule] -> Value

toEncodingList :: [TransferSchedule] -> Encoding

FromJSON TransferSchedule

Defined in StripeAPI.Types.TransferSchedule

Methods

parseJSON :: Value -> Parser TransferSchedule

parseJSONList :: Value -> Parser [TransferSchedule]

mkTransferSchedule

Arguments

:: Int

transferScheduleDelayDays

-> Text

transferScheduleInterval

-> TransferSchedule

Create a new TransferSchedule with all required fields.