Query Manual Charge Reasons

You can retrieve a list of manual charge reasons using the following endpoint and query parameters:

GET https://example-gotransverse.com/billing/2/manual-charge-reasons

Learn what you need to know to successfully retrieve a list of billing accounts in the Query Parameters and Response sections below:

Query Parameters

The following query parameters can be used to filter the query results in addition to the common query parameters available for most GET endpoints:

Query parameters noted as Sortable can be used to organize the query results. Refer to Sort Query Parameter.

Manual Charge Reasons Query Parameters
Name Description Data Type Notes

id

The ID of the manual charge reason.

string

Sortable.

Refer to Retrieve Manual Charge Reason by ID

name

The name of the manual charge reason.

 string

Sortable.

status

The status of the manual charge reason. Available values are:

  • ACTIVE

  • SUSPENDED

  • CANCELED

string

Sortable.

charge_category_id

The unique ID of the charge category.

string

  

charge_category_name

The unique name of the charge category.

string

  

Response

Copy 
[
  {

    "id": "384",
    "name": "Default Manual Charge Reason",
    "description": "Default Manual Charge Reason Description",
    "status": "ACTIVE",
    "reason_type": "manual-charge",
    "charge_category": {
        "id": "1547466"
        "charge_category_type": "manual-charge"
        "name": "Manual Charge Charge Category"
  },
  {

    "id": "496",
    "name": "Manual Charge Reason for Rebilling",
    "status": "SUSPENDED",
    "reason_type": "manual-charge",
    "charge_category": {
        "id": "1547466"
        "charge_category_type": "manual-charge"
        "name": "Manual Charge Charge Category"
     },
  }
]

The following fields are returned when retrieving a manual charge reason:

  • id — The ID of the manual charge reason.

  • name — The name of the manual charge reason.

  • description — (optional) A description of the manual charge reason.

  • status — The status of the manual charge reason.

    • ACTIVE: The reason is an available value for a new manual charge.

    • SUSPENDED: The reason is not an available value for a new manual charge. The reason can be made active again in the future.

    • CANCELED: The reason is not an available value for a new manual charge. The reason can be made active again in the future. The reason can be deleted if it has not been used in a manual charge.

  • reason_type — The type of reason. The only possible value is manual-charge.

  • charge_category — The charge category associated with the manual charge reason.

    • id: The ID of the charge category.

    • charge_category_type: The charge category type.

    • name: The name of the charge category.

 

 

 

Topic Updated: 5/2024.