ScheduleDefaultSettings

Default settings applied to the subscription created by this schedule.

  • billing_cycle_anchor_config
    Type: object | null

    Advanced billing cycle configuration. Allows precise control over when billing cycles occur. All fields are optional integers with specific ranges.

    • day_of_month
      Type: integer
      min:  
      1
      max:  
      31
      required

      Day of month for billing (1–31).

    • hour
      Type: integer | null
      min:  
      0
      max:  
      23

      Hour of day for billing in UTC (0–23).

    • minute
      Type: integer | null
      min:  
      0
      max:  
      59

      Minute of hour for billing (0–59).

    • month
      Type: integer | null
      min:  
      1
      max:  
      12

      Month of year for billing (1–12).

    • second
      Type: integer | null
      min:  
      0
      max:  
      59

      Second of minute for billing (0–59).

  • collection_method
    Type: string | nullenum

    How to collect payment. Defaults to charge_automatically. send_invoice is (coming soon).

    values
    • charge_automatically
    • send_invoice
  • default_payment_method
    Type: string | null

    Payment method ID used when the schedule activates and creates the subscription.