ApiKeyCreateRequest

Request to create an API key

  • name
    Type: string
    required

    Name of the API key to help identify it

  • role
    Type: stringenum
    required
    values
    • ADMIN

      Full administrative access to all resources

    • MEMBER

      Read-only access to all resources

    • DEVELOPER

      Access to payment operations, typically assigned to API keys used for payment integrations

  • livemode
    Type: boolean

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

Examples
{
  "name": "Production API Key",
  "role": "DEVELOPER"
}