API Key

API key metadata used to authenticate API requests.

  • id
    Type: string
    max length:  
    100
    required

    Unique identifier for the object.

  • created
    Type: stringFormat: date-time
    required

    Time at which the API key was created.

  • name
    Type: string
    max length:  
    100
    required

    The API key's display name.

  • type
    Type: string | nullenum
    values
    • secret

      Secret key used by server-side integrations.

    • publishable

      Publishable key used by client-side integrations where supported.

    • restricted

      Restricted key with a limited permission set.

  • status
    Type: string | nullenum
    values
    • active

      Key can authenticate requests.

    • expiring

      Key is still accepted during a rotation grace period.

    • disabled

      Key is disabled and cannot authenticate requests.

    • revoked

      Key has been revoked and cannot authenticate requests.

  • livemode
    Type: boolean
    required

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • permissions
    Type: array of string
    required

    Permissions granted to this API key.

  • role
    Type: string | null

    Role associated with the key when available.

  • secret
    Type: string | null

    Present only on responses explicitly allowed to reveal the key value.

  • secret_redacted
    Type: string | null

    Redacted key value safe for display.

  • expires_at
    Type: string | nullFormat: date-time

    Time at which this key stops being accepted. During rotation this is set on the previous key when a grace period is used.

  • parent_key
    Type: string | null

    Identifier of the key this key was rotated from.

  • replaced_by_key
    Type: string | null

    Identifier of the key that replaced this key during rotation.

  • last_used_at
    Type: string | nullFormat: date-time

    Time at which this API key was last used.

  • revealable
    Type: boolean | null

    Whether this key can be revealed through an explicit reveal endpoint.

  • hide_on_next_view
    Type: boolean | null

    Whether clients should hide the key value after the current view.

  • use_count
    Type: integer | nullFormat: int64

    Number of times this API key has been used, when available.