ListInvoices

POST

https://api.cbf.tcn.com/services/billing/v1alpha1/listinvoices

Lists invoices.
Required permissions:
CUSTOMER_SUPPORT
Errors:

grpc.Internal: An internal error occurred.

grpc.InvalidArgument: The request is invalid.

grpc.PermissionDenied: Caller doesn't have the required permissions.

grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/json

Example

{
    "invoice_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/v1alpha1/listinvoices' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "invoice_id": "string",
    "filter": "string",
    "fields": "string",
    "sort": [
        {
            "key": "string",
            "direction": "ORDER_UNSPECIFIED"
        }
    ],
    "page": {
        "limit": 0,
        "token": "string"
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "invoices": [
        {
            "invoice_id": "string",
            "billing_cycle": "string",
            "create_time": "1s",
            "update_time": "1s",
            "delete_time": "1s",
            "items": [
                {
                    "invoice_item_id": "string",
                    "product": "PRODUCT_UNSPECIFIED",
                    "price": 0,
                    "create_time": "1s",
                    "update_time": "1s",
                    "description": "string",
                    "date": "1s",
                    "columns": [
                        {
                            "name": "string",
                            "value": 0,
                            "column_value": "string"
                        }
                    ],
                    "client_id": "string"
                }
            ],
            "url": "string",
            "client_id": "string"
        }
    ],
    "token": "string"
}

🟢200Success

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

ListBillingPlans

ListRateDefinitions