Docs

api_key.expiring

Occurs when an API key expires in 7 days.

Occurs when an API key is within 7 days of its expiration date. Use this event to rotate or renew the key before it expires to avoid disrupting API requests.

api_key.expired occurs when it reaches its expiration date.

event_idstringrequired
Example: evt_01gks14ge726w50ch2tmaw2a1x
Unique Paddle ID for this event, prefixed with evt_.
Pattern: ^evt_[a-z\d]{26}$
event_typestringrequired
Type of event sent by Paddle, in the format entity.event_type.
Values
+ Show all values
occurred_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this event occurred.
notification_idstringrequired
Example: ntf_01ghbkd0frb9k95cnhwd1bxpvk
Unique Paddle ID for this notification, prefixed with ntf_.
Pattern: ^ntf_[a-z\d]{26}$
dataobjectrequired
New or changed entity.
idstringrequired
Example: apikey_01ghbkd0frb9k95cnhwd1bxpvk
Unique Paddle ID for this API key entity, prefixed with apikey_.
Pattern: ^apikey_[a-z\d]{26}$
namestringrequired
Short name of this API key. Typically unique and human-identifiable.
Length: 1–150
descriptionstring | nullrequired
Short description of this API key. Typically gives details about what the API key is used for and where it's used.
Length: 1–250
keystringrequired
An obfuscated version of this API key, prefixed with pdl_ and containing _apikey_ .
Pattern: ^[a-z\d_:]*\*\*\*\*$
statusstringrequired
Status of this API key.
Values
  • active
  • expired
  • revoked
permissionsarrayrequired
Permissions assigned to this API key. Determines what actions the API key can perform.
string
exposed_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string.
expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string.
last_used_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
api_key.expiring
{
  "event_id": "evt_01jkdr0rc527wcjdg1txsdxhtj",
  "event_type": "api_key.expiring",
  "occurred_at": "2025-06-21T06:58:38.517522Z",
  "notification_id": "ntf_01jkdr1mgbe62eqkh3p0fq8b0m",
  "data": {
    "id": "apikey_01jkdpbhazdpn3wpcya45as9tg",
    "name": "CRM integration",
    "description": "Used to authenticate with the API for storing Paddle customer data in our CRM.",
    "status": "active",
    "key": "pdl_live_apikey_01jkdpbhaz****",
    "permissions": [
      "address.read",
      "business.read",
      "customer.read",
      "subscription.read",
      "transaction.read"
    ],
    "expires_at": "2025-06-26T06:58:38.517522Z",
    "last_used_at": "2025-06-21T05:46:53.238201Z",
    "created_at": "2025-03-26T06:58:38.517522Z",
    "updated_at": "2025-03-26T06:58:38.517522Z",
    "exposed_at": null
  }
}

Was this page helpful?