Skip to main content
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);
{
  "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.