Create Note

View as Markdown

Attach a note to an entity.

An entity can hold at most one note, so creating a second note for the same entity_id returns 409. Use the update endpoint to change existing content.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Request

This endpoint expects an object.
contentstringRequired
The note's text content. No length limit.
entity_idstringRequired
ID of the entity to attach the note to. Any entity's ID is accepted. Maximum 255 characters.

Response

Successful Response
idstring

Unique identifier for the note, prefixed note_.

contentstring
The note's text content.
entity_idstring

ID of the entity this note is attached to, such as a customer (cus_...), subscription (sub_...), or invoice (in_...).

created_atdatetime

When the note was created (UTC).

updated_atdatetime

When the note was last modified (UTC). Equals created_at until the first update.

Errors

409
Conflict Error
422
Unprocessable Entity Error