Paddle Billing
Search

Get a notification

Returns a notification using its ID.

Path Parameters

notification_idstringrequired

Paddle ID of the notification entity to work with.

Response

dataobject

Represents a notification entity.

idstring

Unique Paddle ID for this notification, prefixed with ntf_.

typestring

Type of event sent by Paddle, in the format entity.event_type.

statusstring

Status of this notification.

payloadobject

Notification payload. Includes the new or changed event.

occurred_atstring<date-time>

RFC 3339 datetime string of when this notification occurred.

delivered_atstring<date-time> or null

RFC 3339 datetime string of when this notification was delivered. null if not yet delivered successfully.

replayed_atstring<date-time> or null

RFC 3339 datetime string of when this notification was replayed. null if not replayed.

originstring

Describes how this notification was created.

last_attempt_atstring<date-time> or null

RFC 3339 datetime string of when this notification was last attempted.

retry_atstring<date-time> or null

RFC 3339 datetime string of when this notification is scheduled to be retried.

times_attemptedinteger

How many times delivery of this notification has been attempted. Automatically incremented by Paddle after an attempt.

notification_setting_idstring

Unique Paddle ID for this notification setting, prefixed with ntfset_.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.