CreateDefaultRateDefinition

POST

https://api.cbf.tcn.com/services/billing/v1alpha4/createdefaultratedefinition

Creates a new rate definition for a default plan.

Creating a rate definition on an existing SKU: the sku_id must be provided.

Creating a rate definition on a new SKU: the product must be provided and the sku_id omitted.
Required permissions:
CUSTOMER_SUPPORT
TCN_BILLING_ADMIN
Errors:

grpc.Internal: An internal error occurred.

grpc.InvalidArgument: The request is invalid.

grpc.NotFound: The billing plan 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/json

Example

{
    "rate_definition_id": "string",
    "rate_definition": {
        "rate_definition_id": "string",
        "sku_id": "string",
        "billing_tag": {
            "billing_tag_id": "string",
            "name": "string",
            "create_time": "1s",
            "update_time": "1s",
            "delete_time": "1s",
            "category": "string",
            "billing_category": "CATEGORY_UNSPECIFIED"
        },
        "config": {
            "communications_omni_agent_seats": {
                "rate": {
                    "value": "string"
                },
                "precision": 0
            }
        },
        "is_draft": true,
        "is_overwrite": true,
        "create_time": "1s",
        "update_time": "1s",
        "delete_time": "1s",
        "billing_tag_id": "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/v1alpha4/createdefaultratedefinition' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rate_definition_id": "string",
    "rate_definition": {
        "rate_definition_id": "string",
        "sku_id": "string",
        "billing_tag": {
            "billing_tag_id": "string",
            "name": "string",
            "create_time": "1s",
            "update_time": "1s",
            "delete_time": "1s",
            "category": "string",
            "billing_category": "CATEGORY_UNSPECIFIED"
        },
        "config": {
            "communications_omni_agent_seats": {
                "rate": {
                    "value": "string"
                },
                "precision": 0
            }
        },
        "is_draft": true,
        "is_overwrite": true,
        "create_time": "1s",
        "update_time": "1s",
        "delete_time": "1s",
        "billing_tag_id": "string"
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "rate_definition_id": "string"
}

🟢200Success

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

UpdateRateDefinition

DeleteDefaultRateDefinition