Querying for trouble tickets

Use the following endpoints to query for trouble tickets:

  • GET /billing/v1/trouble-tickets/{troubleTicketId}
  • GET /billing/v1/accounts/{accountId}/trouble-tickets
  • GET /billing/v1/accounts/{accountId}/policies/{policyId}/trouble-tickets
  • GET /billing/v1/producers/{producerId}/trouble-tickets
  • GET /billing/v1/accounts/{accountId}/policies/{policyId}/policy-periods/{policyPeriodId}/trouble-tickets

Querying for a specific trouble ticket

Use the following endpoint to retrieve a specific trouble ticket by its ID:

  • GET /billing/v1/trouble-tickets/{troubleTicketId}
Request
GET /billing/v1/trouble-tickets/bc:Sd6g5vWGDOXURvwKI-8iH

Response:

{
    "data": {
        "attributes": {
            "assignedByUser": {
                "displayName": "Super User",
                "id": "default_data:1",
                "type": "User",
                "uri": "/admin/v1/users/default_data:1"
            },
            "assignedGroup": {
                "displayName": "Group 1",
                "id": "bc:SbzhiezdhOfhzGT0deVod",
                "type": "Group",
                "uri": "/admin/v1/groups/bc:SbzhiezdhOfhzGT0deVod"
            },
            "assignedUser": {
                "displayName": "Super Visor",
                "id": "bc:S-sQnpTScVgwx_wRW0qvm",
                "type": "User",
                "uri": "/admin/v1/users/bc:S-sQnpTScVgwx_wRW0qvm"
            },
            "assignmentDate": "2026-05-20T21:16:19.646Z",
            "assignmentStatus": {
                "code": "assigned",
                "name": "Assigned"
            },
            "createTime": "2026-05-20T21:16:19.646Z",
            "createUser": {
                "displayName": "Super User",
                "id": "default_data:1",
                "type": "User",
                "uri": "/admin/v1/users/default_data:1"
            },
            "detailedDescription": "Billing resolution inquiry",
            "escalated": false,
            "id": "bc:Sd6g5vWGDOXURvwKI-8iH",
            "priority": {
                "code": "high",
                "name": "High"
            },
            "ticketStatus": "Open",
            "ticketType": {
                "code": "processingerror",
                "name": "Processing Error"
            },
            "title": "fa",
            "troubleTicketNumber": "1000000000"
        },
        ...
    }
}

Querying for trouble tickets on an account, policy, policy period, or producer

Use the relevant endpoint when querying for trouble tickets on accounts, policies, policy periods, or producers.

  • GET /billing/v1/accounts/{accountId}/trouble-tickets
  • GET /billing/v1/accounts/{accountId}/policies/{policyId}/trouble-tickets
  • GET /billing/v1/producers/{producerId}/trouble-tickets
  • GET /billing/v1/accounts/{accountId}/policies/{policyId}/policy-periods/{policyPeriodId}/trouble-tickets

These endpoints return trouble tickets that are linked to the account, policy, policy period, or producer using a join entity. To establish this link using Cloud API, see Trouble ticket join entities.

Command

GET /billing/v1/accounts/bc:394130412067/trouble-tickets

Response

{
    "count": 2,
    "data": [
        {
            "attributes": {
                "assignedByUser": {
                    "displayName": "Super User",
                    "id": "default_data:1",
                    "type": "User",
                    "uri": "/admin/v1/users/default_data:1"
                },
                "assignedGroup": {
                    "displayName": "Group 1",
                    "id": "bc:SbzhiezdhOfhzGT0deVod",
                    "type": "Group",
                    "uri": "/admin/v1/groups/bc:SbzhiezdhOfhzGT0deVod"
                },
                "assignedUser": {
                    "displayName": "Super Visor",
                    "id": "bc:S-sQnpTScVgwx_wRW0qvm",
                    "type": "User",
                    "uri": "/admin/v1/users/bc:S-sQnpTScVgwx_wRW0qvm"
                },
                "assignmentDate": "2026-05-20T21:16:19.646Z",
                "assignmentStatus": {
                    "code": "assigned",
                    "name": "Assigned"
                },
                "createTime": "2026-05-20T21:16:19.646Z",
                "createUser": {
                    "displayName": "Super User",
                    "id": "default_data:1",
                    "type": "User",
                    "uri": "/admin/v1/users/default_data:1"
                },
                "escalated": false,
                "id": "bc:Sd6g5vWGDOXURvwKI-8iH",
                "priority": {
                    "code": "high",
                    "name": "High"
                },
                "ticketStatus": "Open",
                "ticketType": {
                    "code": "processingerror",
                    "name": "Processing Error"
                },
                "title": "fa",
                "troubleTicketNumber": "1000000000"
            },
            "checksum": "0",
            "links": {
                ...
            }
            ...
        }
    }
}

You can also request trouble tickets as an inclusion on a GET request:

GET /billing/v1/accounts/{accountId}/policies/{policyId}?include=trouble-tickets