ApiKeyCreateRequest

Request parameters for creating 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

    Creates the key in live mode when set to true; otherwise creates the key in test mode.

Examples 
{
  "name": "Production backend",
  "role": "DEVELOPER",
  "livemode": true
}