Retrieve Credit Usage

Retrieves the usage of currently available credits.

🔔 API Update & Backward Compatibility Notice

The TRADLINX Ocean Visibility API may be updated from time to time to improve service quality, expand data coverage, and introduce new features.

When updating the API, we prioritize the stable operation of existing integrations and follow backward-compatible change principles, such as adding new fields.

Accordingly, we recommend that client systems be implemented in a backward-compatible manner so that they can continue to operate normally even when unknown or newly added fields are included in API responses.

If any changes may affect existing integrations, we will provide advance notice.

Request

GET /partners/track/v3/credits/usage

curl -X GET "https://api.tradlinx.com/partners/track/v3/credits/usage" \
  -H "tx-clientid: [Client ID]" \
  -H "tx-apikey: [API Key]" \
  -H "Content-Type: application/json"

Response

{
    "api_version": "v3",
    "transaction_time": "2025-07-08T08:01:16.533152",
    "content": [
        {
            "creditType": "T_CREDIT",
            "credit": 100,
            "usedCredit": 30,
            "remainCredit": 70,
            "startAt": "2024-12-22T15:00:00",
            "expiredAt": "2029-12-22T15:00:00"
        },
        {
            "creditType": "PLAN_CREDIT",
            "credit": 500000,
            "usedCredit": 5950,
            "remainCredit": 494050,
            "startAt": "2025-06-30T15:00:00",
            "expiredAt": "2025-07-31T15:00:00"
        }
    ]
}

Response Body

Field	Type	Description	Remark
api_version	string	API version	v3
content	CreditResponse[]	Available credit info
transaction_time	string	Response timestamp	yyyy-MM-dd'T'HH:mm:ss.SSSSSS

CreditResponse — Available Credit Info

Field	Type	Description
creditType	string	Type of credit (see list below)
credit	number	Allocated amount of available credits
usedCredit	number	Used amount of available credits
remainCredit	number	Remaining amount of available credits
startAt	string	Start date of the credit availability period (yyyy-MM-dd'T'HH:mm:ss)
expiredAt	string	End date of the credit availability period (yyyy-MM-dd'T'HH:mm:ss)

Credit Types

Code	Description
PLAN_CREDIT	Credits provided during the plan period
T_CREDIT	Credits available outside of the plan period

400 Error

{
	"error_detail": "This feature is not supported in your plan.",
	"transaction_time": "2025-03-20T05:42:27.123243"
}

500 Error

{
	"status": 500,
	"type": "Internal Server Error",
	"message": "Internal server error. Please try again in a few minutes."
}