Schedule a billing contract change

POST

/v1/account/contract/change

curl --request POST \
  --url https://dev-api.infiniteaudience.ai/v1/account/contract/change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "request_id": "example", "tier": "starter", "cadence": "monthly" }'

• Development API Server

Schedules the selected tier and cadence at the next verified contract billing boundary. Enterprise custom terms remain platform-admin managed. Parent-billed children cannot change the agency contract. Requires ‘account’ scope.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

request_id

required

string

>= 8 characters <= 160 characters

tier

required

string

Allowed values: starter growth enterprise

cadence

string

Allowed values: monthly annual

Responses

202

Contract replacement scheduled

Media typeapplication/json

object

status

required

string

Allowed value: scheduled

effective_at

required

string format: date-time

scheduled_change

required

object

kind

required

string

Allowed values: replacement renewal cancellation

request_id

required

string

status

required

string

Allowed values: provisioning scheduled failed

effective_at

required

string format: date-time

previous_contract_end_at

required

string | null format: date-time

successor_contract_id

required

string | null

terms

required

One of:

object

object

tier

required

string

Allowed values: paygo starter growth enterprise

cadence

required

string

Allowed values: monthly annual

commitment_term_months

required

integer

Allowed values: 0 12 24 36

commitment_amount_cents

required

integer

usage_discount_bps

required

integer

<= 10000

usage_rates

required

object

match

required

object

microbatch

required

integer

file

required

integer

audience_delivery

required

object

filter

required

integer

matched

required

integer

similarity

required

integer

propensity

required

integer

destination

required

object

key

additional properties

integer

enrichment_field

required

object

key

additional properties

integer

null

null

error_code

required

string | null

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "status": "scheduled",
  "scheduled_change": {
    "kind": "replacement",
    "status": "provisioning",
    "terms": {
      "tier": "paygo",
      "cadence": "monthly",
      "commitment_term_months": 0
    }
  }
}

400

Invalid request — malformed body, missing required attribute, or failed validation. See error and message for details.

Media typeapplication/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

Examplevalidation_error

{
  "error": "Bad Request",
  "code": "MISSING_SEGMENTS",
  "message": "segment_ids is required for filter audiences."
}

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).

Media typeapplication/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).

Media typeapplication/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

Examplemissing_scope

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

409

Resource state conflicts with the request. For upload analysis this includes FILE_NOT_YET_UPLOADED.

Media typeapplication/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

Example^generated

{
  "error": "example",
  "message": "example",
  "code": "example",
  "request_id": "example"
}

422

Request is structurally valid but the resource is in a state that prevents the operation (e.g. expired, pending, or not yet uploaded). See error and code for the specific reason.

Media typeapplication/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": "Audience expired",
  "code": "AUDIENCE_EXPIRED",
  "message": "This audience version expired. Run a refresh to create a new deliverable version."
}

{
  "error": "Audience not ready",
  "code": "AUDIENCE_PENDING",
  "message": "This audience is still being processed. Poll GET /v1/audiences/{id} until status is active."
}

502

An upstream billing provider rejected or could not complete the operation.

Media typeapplication/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

Example^generated

{
  "error": "example",
  "message": "example",
  "code": "example",
  "request_id": "example"
}