The ReportSchedule object

Configuration for a scheduled recurring report. Scheduled reports are automatically generated and delivered to specified recipients on a recurring basis.

Fields

Field	Type	Description
id REQUIRED	string	Unique identifier for the schedule
merchantId REQUIRED	string	ID of the merchant who owns the schedule
type REQUIRED	ReportType	Type of report to generate ReportType
format REQUIRED	ReportFormat	Output format for the report ReportFormat
frequency REQUIRED	'daily'\| 'weekly'\| 'monthly'	How often to generate the report
dayOfWeek OPTIONAL	number	Day of week for weekly reports (0=Sunday, 6=Saturday)
dayOfMonth OPTIONAL	number	Day of month for monthly reports (1-31)
time REQUIRED	string	Time to generate the report (HH:MM in merchant's timezone)
recipients REQUIRED	string[]	Email addresses to receive the report
isActive REQUIRED	boolean	Whether the schedule is currently active
lastRunAt OPTIONAL	string	ISO 8601 timestamp of the last report generation
nextRunAt OPTIONAL	string	ISO 8601 timestamp of the next scheduled generation
createdAt REQUIRED	string	ISO 8601 timestamp when the schedule was created

Example

{
  "id": "obj_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "type": "transactions",
  "format": "csv",
  "frequency": "daily",
  "dayOfWeek": 1,
  "dayOfMonth": 1,
  "time": "string",
  "recipients": [],
  "isActive": false,
  "createdAt": "2026-01-15T09:30:00Z"
}

Fields​

Example​

Fields

Example