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
Paddle Docs home

api_key.created

Occurs when an API key is created.

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
    View customer addresses and include address data in API responses.
  • address.write
    Create and update customer addresses.
  • adjustment.read
    View adjustments and credit notes for transactions.
  • adjustment.write
    Create new adjustments for transactions.
  • business.read
    View customer businesses and include business data in API responses.
+ Show all values
  • business.write
    Create and update customer businesses.
  • checkout_domain.read
    View checkout domains, their approval status, and payment method verification status.
  • checkout_domain.write
    Delete checkout domains, and trigger payment method verification (Apple Pay) for approved checkout domains.
  • client_token.read
    View client-side tokens.
  • client_token.write
    Create and update client-side tokens.
  • customer.read
    View customers, including credit balances, and include customer data in API responses.
  • customer.write
    Create new customers and update existing customer information.
  • customer_auth_token.write
    Generate authentication tokens for customers.
  • customer_portal_session.write
    Create new customer portal sessions for customers to manage their subscriptions, payment methods, and more.
  • discount.read
    View discounts and include discount data in API responses.
  • discount.write
    Create new discounts and modify existing discount information.
  • metrics.read
    View metrics data including revenue, subscribers, and conversion timeseries.
  • notification.read
    View event history, sent notifications, notification delivery logs, and include event data in API responses.
  • notification.write
    Replay notifications.
  • notification_setting.read
    View settings for notifications.
  • notification_setting.write
    Create, update, and delete notification settings.
  • notification_simulation.read
    View notification simulations, simulation runs, and events within a simulation run.
  • notification_simulation.write
    Create and modify notification simulations, create a run for a simulation, and replay events within a run for a simulation.
  • payment_method.read
    View saved payment methods for customers.
  • payment_method.write
    Delete payment methods for customers.
  • price.read
    View prices and include price data in API responses.
  • price.write
    Create new prices and modify existing price information.
  • product.read
    View products and include product data in API responses.
  • product.write
    Create new products and modify existing product information.
  • report.read
    View and download report data.
  • report.write
    Create new reports.
  • subscription.read
    View subscriptions and preview subscription updates and charges.
  • subscription.write
    Create one-time charges, update subscriptions, and manage subscription status.
  • subscription_history.read
    View subscription history entries for a subscription.
  • transaction.read
    View transactions, preview transactions and prices, access invoices, and include transaction data in API responses.
  • transaction.write
    Create, update, and revise transactions, and update payment methods.
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.
rotatableboolean | nullrequired
Whether this API key can be rotated. null for events that occurred before this field was introduced.
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.created
{
  "event_id": "evt_01jkdr0rc527wcjdg1txsdxhtf",
  "event_type": "api_key.created",
  "occurred_at": "2025-03-26T06:58:38.517522Z",
  "notification_id": "ntf_01jkdr1mgbe62eqkh3p0fq8b0h",
  "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",
    "rotatable": true,
    "last_used_at": null,
    "created_at": "2025-03-26T06:58:38.517522Z",
    "updated_at": "2025-03-26T06:58:38.517522Z",
    "exposed_at": null
  }
}

Was this page helpful?