For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Docs

api_key.expired

Occurs when an API key has expired.

Occurs when an API key has reached its expiration date. The key's status changes to expired and it can no longer be used to authenticate API requests.

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
Values
  • address.read
  • address.write
  • adjustment.read
  • adjustment.write
  • business.read
+ Show all values
  • business.write
  • checkout_domain.read
  • checkout_domain.write
  • client_token.read
  • client_token.write
  • customer.read
  • customer.write
  • customer_auth_token.write
  • customer_portal_session.write
  • discount.read
  • discount.write
  • metrics.read
  • notification.read
  • notification.write
  • notification_setting.read
  • notification_setting.write
  • notification_simulation.read
  • notification_simulation.write
  • payment_method.read
  • payment_method.write
  • price.read
  • price.write
  • product.read
  • product.write
  • report.read
  • report.write
  • subscription.read
  • subscription.write
  • transaction.read
  • transaction.write
exposed_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this API key was first exposed. null if never exposed.
expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this API key expires.
last_used_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this API key was last used (accurate to within 1 hour). null if never used.
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.expired
{
  "event_id": "evt_01jkdr0rc527wcjdg1txsdxhth",
  "event_type": "api_key.expired",
  "occurred_at": "2025-03-26T06:58:38.517522Z",
  "notification_id": "ntf_01jkdr1mgbe62eqkh3p0fq8b0k",
  "data": {
    "id": "apikey_01jkdpbhazdpn3wpcya45as9tg",
    "name": "CRM integration",
    "description": "Used to authenticate with the API for storing Paddle customer data in our CRM.",
    "status": "expired",
    "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-26T05:54:22.738201Z",
    "created_at": "2025-03-26T06:58:38.517522Z",
    "updated_at": "2025-03-26T06:58:38.517522Z",
    "exposed_at": null
  }
}

Was this page helpful?