Skip to main content

Tariff Plan Info

Returns information about the current user’s active tariff plan in BitOK.

HTTP Request

GET /v1/basics/tariff-plan/

This endpoint does not accept any query parameters.

Response

A successful response returns HTTP 200 OK with a JSON body describing the currently active plan.

Response Fields

FieldTypeDescription
plan_namestringThe name or code of the active tariff plan.
activated_atstringISO 8601 timestamp when the plan was activated.
expired_atstringISO 8601 timestamp when the plan will expire.
checks_availableintegerNumber of AML/KYT checks remaining under the current plan.
checks_usedintegerNumber of AML/KYT checks already used.

Example Response

{
"plan_name": "500",
"activated_at": "2025-04-02T16:48:02+03:00",
"expired_at": "2026-04-02T16:48:08+03:00",
"checks_available": 141,
"checks_used": 359
}
GET/v1/basics/tariff-plan/
API KEY ID
API KEY SECRET
HTTP Request
Press "Send Request" to generate HTTP request.
HTTP …
{
// Response will be shown here after the request.
}