Object Index / Definition

You are viewing an old version of the API
Catalog​Time​Period

Beta

Represents a time period - either a single period or a repeating period

Properties

Name Description
event
string

An iCalendar (RFC5545) event, which specifies the name, timing, duration and recurrence of this time period.

Example:

DTSTART:20190707T180000
DURATION:P2H
RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR

Only SUMMARY, DTSTART, DURATION and RRULE fields are supported. DTSTART must be in local (unzoned) time format. Note that while BEGIN:VEVENT and END:VEVENT is not required in the request. The response will always include them.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?