Get billing preferences

GET

/v1/settings/billing-preferences

const url = 'https://dev-api.infiniteaudience.ai/v1/settings/billing-preferences';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dev-api.infiniteaudience.ai/v1/settings/billing-preferences \
  --header 'Authorization: Bearer <token>'

Returns platform-owned billing safeguards. The low-balance threshold applies to prepay accounts; budget_ceiling applies to postpay accounts. Explicit payment-gated top-ups replace the retired local automatic-overage-charge preference. Requires ‘account’ scope.

Authorizations

bearerAuth

Responses

200

Current billing preferences.

application/json

object

billing_model

required

string

Allowed values: prepay postpay

low_balance_threshold

required

Prepay only — always null for postpay.

number | null

budget_ceiling

required

Postpay only — always null for prepay. Null also means unset (unlimited) for postpay.

number | null

Example

{
  "billing_model": "prepay"
}

401

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

{
  "error": "Unauthorized: Missing or invalid Authorization header"
}

{
  "error": "Unauthorized",
  "code": "TOKEN_EXPIRED",
  "message": "Your session has expired. Please sign in again."
}

403

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

missing_scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This endpoint requires the purchase scope."
}