Skip to main content

Overview

Retrieves the current credit balance for your account, along with the total credits allotted and the account’s expiry period.

Endpoint Details

  • Method: GET
  • Endpoint: /api/wkl/credits/get-credits-balance/

Authentication requirements

  • Include a valid JWT token in your request header
  • If you don’t have a token yet, you can get one from the /auth/token/ endpoint first.

Request

Request Parameters

Header Parameters

string
required
JWT token obtained from the Authentication request
string
required
Must be set to application/json
This endpoint takes no URL or body parameters.

Response

Successful response will include the credits_consumed, acount_expiry_period, credits_balance, and total_credits fields. Sample Response
Response Fields