Get the calling user's Terms of Service status

Returns whether the authenticated user has agreed to the current Terms of Service for the product given by product_type. Used during onboarding to decide whether to prompt the user with the ToS dialog before continuing.

agreement_required: true means the user has not yet agreed (or has agreed to an outdated version) and must agree before using that product’s endpoints.

GET

terms_of_service

status

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.termsOfService.status();

console.log(response.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.terms_of_service.status()
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.TermsOfService.Status(context.TODO(), telnyx.TermsOfServiceStatusParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.termsofservice.TermsOfServiceStatusParams;
import com.telnyx.sdk.models.termsofservice.TermsOfServiceStatusResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        TermsOfServiceStatusResponse response = client.termsOfService().status();
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.terms_of_service.status

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->termsOfService->status(productType: 'branded_calling');

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx terms-of-service status \
  --api-key 'My API Key'

curl --request GET \
  --url https://api.telnyx.com/v2/terms_of_service/status \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "product_type": "branded_calling",
    "current_terms_version": "v1.1.0",
    "has_agreed": false,
    "agreement_required": true,
    "agreed_version": "v1.0.0",
    "agreed_at": "2025-07-10T10:30:00Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

product_type

enum<string>

Which product's ToS to check. Defaults to branded_calling. Telnyx product the Terms of Service apply to.

Available options:

branded_calling,

number_reputation

Example:

"branded_calling"

Response

Status.

data

object

required

Whether the calling user has agreed to a product's current Terms of Service. The user_id is intentionally omitted on this public surface.

Show child attributes

Get Terms of Service information

List the calling user's Terms of Service agreements

⌘I

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.termsOfService.status();

console.log(response.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.terms_of_service.status()
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.TermsOfService.Status(context.TODO(), telnyx.TermsOfServiceStatusParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.termsofservice.TermsOfServiceStatusParams;
import com.telnyx.sdk.models.termsofservice.TermsOfServiceStatusResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        TermsOfServiceStatusResponse response = client.termsOfService().status();
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.terms_of_service.status

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->termsOfService->status(productType: 'branded_calling');

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx terms-of-service status \
  --api-key 'My API Key'

curl --request GET \
  --url https://api.telnyx.com/v2/terms_of_service/status \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "product_type": "branded_calling",
    "current_terms_version": "v1.1.0",
    "has_agreed": false,
    "agreement_required": true,
    "agreed_version": "v1.0.0",
    "agreed_at": "2025-07-10T10:30:00Z"
  }
}

Branded Calling

For AI Agents

Get the calling user's Terms of Service status

Authorizations

Query Parameters

Response