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

authorUserRequired

The details of the user that created the note.

author_idstringRequired

The ID of the user that created the note.

created_atDateRequired

The date with timezone at which the resource was created.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

idstringRequired

The note's ID

metadataRecord<string, unknown>Required

An optional key-value map with additional details

resource_idstringRequired

The ID of the resource that the Note refers to.

resource_typestringRequired

The type of resource that the Note refers to.

updated_atDateRequired

The date with timezone at which the resource was updated.

valuestringRequired

The contents of the note.