Set auto top-up configuration

client.aiGateway.billing.topup.config.create(, ?): ConfigCreateResponse { amount, threshold }

POST/accounts/{account_id}/ai-gateway/billing/topup/config

Configure auto top-up with a balance threshold and top-up amount.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

AI Gateway Write

ParametersExpand Collapse

params: ConfigCreateParams { account_id, amount, threshold }

account_id: string

Path param: Cloudflare account ID.

amount: number

Body param: Auto top-up amount in cents (min 1000).

minimum1000

threshold: number

Body param: Balance threshold in cents that triggers auto top-up (min 500).

minimum500

ReturnsExpand Collapse

ConfigCreateResponse { amount, threshold }

amount: number

threshold: number

Set auto top-up configuration

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const config = await client.aiGateway.billing.topup.config.create({
  account_id: 'account_id',
  amount: 5000,
  threshold: 500,
});

console.log(config.amount);

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "amount": 0,
    "threshold": 0
  },
  "success": true,
  "result_info": {
    "has_more": true,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "amount": 0,
    "threshold": 0
  },
  "success": true,
  "result_info": {
    "has_more": true,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  }
}