ShopifyPaymentsPayoutSchedule

Version 2019-04

The payment schedule for a payments account.

Required access

read_shopify_payments access scope

Show definition
"""
The payment schedule for a payments account.
"""
type ShopifyPaymentsPayoutSchedule {
  """
  The interval at which payouts are sent to the connected bank account.
  """
  interval: ShopifyPaymentsPayoutInterval!
  """
  The day of the month funds will be paid out.
  The value can be any day of the month from the 1st to the 31st.
  If the payment interval is set to monthly, this value will be used.
  Payouts scheduled between 29-31st of the month are sent on the last day of shorter months.
  """
  monthlyAnchor: Int
  """
  The day of the week funds will be paid out.
  The value can be any weekday from Monday to Friday.
  If the payment interval is set to weekly, this value will be used.
  """
  weeklyAnchor: DayOfTheWeek
}

Fields

interval (ShopifyPaymentsPayoutInterval!)

The interval at which payouts are sent to the connected bank account.

monthlyAnchor (Int)

The day of the month funds will be paid out.

The value can be any day of the month from the 1st to the 31st. If the payment interval is set to monthly, this value will be used. Payouts scheduled between 29-31st of the month are sent on the last day of shorter months.

weeklyAnchor (DayOfTheWeek)

The day of the week funds will be paid out.

The value can be any weekday from Monday to Friday. If the payment interval is set to weekly, this value will be used.

Version 2019-07 (Latest)

The payment schedule for a payments account.

Required access

read_shopify_payments access scope

Show definition
"""
The payment schedule for a payments account.
"""
type ShopifyPaymentsPayoutSchedule {
  """
  The interval at which payouts are sent to the connected bank account.
  """
  interval: ShopifyPaymentsPayoutInterval!
  """
  The day of the month funds will be paid out.
  The value can be any day of the month from the 1st to the 31st.
  If the payment interval is set to monthly, this value will be used.
  Payouts scheduled between 29-31st of the month are sent on the last day of shorter months.
  """
  monthlyAnchor: Int
  """
  The day of the week funds will be paid out.
  The value can be any weekday from Monday to Friday.
  If the payment interval is set to weekly, this value will be used.
  """
  weeklyAnchor: DayOfTheWeek
}

Fields

interval (ShopifyPaymentsPayoutInterval!)

The interval at which payouts are sent to the connected bank account.

monthlyAnchor (Int)

The day of the month funds will be paid out.

The value can be any day of the month from the 1st to the 31st. If the payment interval is set to monthly, this value will be used. Payouts scheduled between 29-31st of the month are sent on the last day of shorter months.

weeklyAnchor (DayOfTheWeek)

The day of the week funds will be paid out.

The value can be any weekday from Monday to Friday. If the payment interval is set to weekly, this value will be used.

Version 2019-10 (Release candidate)

The payment schedule for a payments account.

Required access

read_shopify_payments access scope

Show definition
"""
The payment schedule for a payments account.
"""
type ShopifyPaymentsPayoutSchedule {
  """
  The interval at which payouts are sent to the connected bank account.
  """
  interval: ShopifyPaymentsPayoutInterval!
  """
  The day of the month funds will be paid out.
  The value can be any day of the month from the 1st to the 31st.
  If the payment interval is set to monthly, this value will be used.
  Payouts scheduled between 29-31st of the month are sent on the last day of shorter months.
  """
  monthlyAnchor: Int
  """
  The day of the week funds will be paid out.
  The value can be any weekday from Monday to Friday.
  If the payment interval is set to weekly, this value will be used.
  """
  weeklyAnchor: DayOfTheWeek
}

Fields

interval (ShopifyPaymentsPayoutInterval!)

The interval at which payouts are sent to the connected bank account.

monthlyAnchor (Int)

The day of the month funds will be paid out.

The value can be any day of the month from the 1st to the 31st. If the payment interval is set to monthly, this value will be used. Payouts scheduled between 29-31st of the month are sent on the last day of shorter months.

weeklyAnchor (DayOfTheWeek)

The day of the week funds will be paid out.

The value can be any weekday from Monday to Friday. If the payment interval is set to weekly, this value will be used.

Sign up for a Partner account to get started.

Sign up