Update Note

View as Markdown

Replace a note’s content.

The note stays attached to the same entity; entity_id cannot be changed.

Authentication

AuthorizationBearer

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

Path parameters

note_idstringRequired
account_idstringRequired

Request

This endpoint expects an object.
contentstringRequired
The note's new text content. Replaces the existing content.

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

422
Unprocessable Entity Error