ListRateDefinitions

POST

https://api.cbf.tcn.com/services/billing/v1alpha3/listratedefinitions

Lists rate definitions.
Required permissions:
CUSTOMER_SUPPORT
Errors:

grpc.Internal: An internal error occurred.

grpc.InvalidArgument: The request is invalid.

grpc.NotFound: The rate definition was not found.

grpc.PermissionDenied: The caller does not have the required permissions.

grpc.Unavailable: The operation is currently unavailable.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "rate_definition_id": "string",
    "filter": "string",
    "fields": "string",
    "sort": [
        {
            "key": "string",
            "direction": "ORDER_UNSPECIFIED"
        }
    ],
    "page": {
        "limit": 0,
        "token": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/services/billing/v1alpha3/listratedefinitions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rate_definition_id": "string",
    "filter": "string",
    "fields": "string",
    "sort": [
        {
            "key": "string",
            "direction": "ORDER_UNSPECIFIED"
        }
    ],
    "page": {
        "limit": 0,
        "token": "string"
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "rate_definitions": [
        {
            "rate_definition_id": "string",
            "sku_id": "string",
            "product": {
                "category_one": "string",
                "category_two": "string",
                "category_three": "string",
                "product_name": "string"
            },
            "config": {
                "communications_omni_agent_seats": {
                    "rate": {
                        "value": "string"
                    },
                    "precision": 0
                }
            },
            "is_draft": true,
            "create_time": "1s",
            "update_time": "1s",
            "delete_time": "1s"
        }
    ],
    "token": "string"
}

🟢200Success

Modified at 2025-09-26 15:44:58

GetRateDefinition

UpdateRateDefinition