Paddle Billing
Search

List notifications

Returns a paginated list of notifications created in the last 90 days. Use the query parameters to page through results.

Notifications older than 90 days aren't retained.

Query Parameters

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

notification_setting_idarray[string]

Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination IDs.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

searchstring

Return entities that match a search query. Searches id and type fields.

statusarray[string]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

filterstring

Return entities that contain the Paddle ID specified. Pass a transaction, customer, or subscription ID.

tostring

Return entities up to a specific time.

fromstring

Return entities from a specific time.

Response

dataarray[object]

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.

paginationobject

Keys used for working with paginated results.