Object Index / Definition

You are viewing an old version of the API
Break​Type

A defined break template that sets an expectation for possible Break instances on a Shift

Properties

Name Description
id
string

UUID for this object.

Max Length 255
break_name
string

Required

A human-readable name for this type of break. Will be displayed to employees in Square products.

Min Length 1
expected_duration
string

Required

Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision below minutes is truncated.

Min Length 1
is_paid
boolean

Required

Whether this break counts towards time worked for compensation purposes.

location_id
string

Required

The ID of the business location this type of break applies to.

Min Length 1
created_at
string

A read-only timestamp in RFC 3339 format.

updated_at
string

A read-only timestamp in RFC 3339 format.

version
integer

Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If a value is not provided, Square's servers execute a "blind" write; potentially overwriting another writer's data.

Share Feedback

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