WireBloomDevelopers

    ScheduledPayment

    Schema #/components/schemas/ScheduledPayment of contract 1.0.0-draft.14.

    • id Uuidrequiredread-only

      Fields of id

      Uuid

    • customerId Uuidrequiredread-only

      Fields of customerId

      Uuid

    • name string | null

      max length 100

    • template ScheduledPaymentTemplate | CollectionScheduleTemplaterequired

    • schedule objectrequired

      Fields of schedule

      • rrule stringrequired

        RFC 5545 RRULE.

      • startDate Daterequired

      • endDate Date | null

      • timezone string

    • status ScheduledPaymentStatusrequiredread-only

      Fields of status

      ScheduledPaymentStatus

    • nextRunAt Timestamp | null

    • lastPaymentId Uuid | null

    • createdAt Timestamprequiredread-only

      Fields of createdAt

      Timestamp

    • updatedAt Timestampread-only

      Fields of updatedAt

      Timestamp

    • kind stringread-only

      One of: "payment", "collection"

    • nextExecutionDate Date | null

    • consecutiveFailures integerread-only

      Failed runs in a row; three deactivate the schedule.

      min 0

    • preApproved booleanread-only

      Runs skip the approval tier (operator setting payments.scheduled.preApproveStandingOrders, approved at creation).

    • statusReason string | nullread-only