Get Note By Entity

View as Markdown
Retrieve the note attached to an entity, by the entity's ID. Use this when you know what the note is about but not the note's own ID. Returns 404 when the entity has no note.

Authentication

AuthorizationBearer

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

Path parameters

entity_idstringRequired
account_idstringRequired

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