Note
A Note is an element that can be used in association with different resources to allow admin users to describe additional information. For example, they can be used to add additional information about orders.
Properties
id
stringRequiredThe note's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
value
stringRequiredThe contents of the note.
resource_type
stringRequiredThe type of resource that the Note refers to.
resource_id
stringRequiredThe ID of the resource that the Note refers to.
author_id
stringRequiredThe ID of the user that created the note.
The details of the user that created the note.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
Was this section helpful?