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

idstringRequired

The note's ID

created_atDateRequired

The date with timezone at which the resource was created.

updated_atDateRequired

The date with timezone at which the resource was updated.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

valuestringRequired

The contents of the note.

resource_typestringRequired

The type of resource that the Note refers to.

resource_idstringRequired

The ID of the resource that the Note refers to.

author_idstringRequired

The ID of the user that created the note.

authorUserRequired

The details of the user that created the note.

metadataRecord<string, unknown>Required

An optional key-value map with additional details