Credit balance

Your credit balance and the top-up price list. Credits pay for paid checks (1 credit = $0.01 at the base rate). `balance` is monthly + pack; `available` also subtracts credits held by pending reservations. Free to read.

GET/api/v1/credits

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Responses

Your credits.

availableinteger

balanceinteger

check_costinteger

monthlyinteger

monthly_resets_atany

packinteger

pendinginteger

topupobject

curl --request GET \
  --url "https://getrevised.com/api/v1/credits" \
  --header "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://getrevised.com/api/v1/credits", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  },
});
const data = await res.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

r = requests.get("https://getrevised.com/api/v1/credits", headers=headers)
r.raise_for_status()
data = r.json()

{
  "available": 123,
  "balance": 123,
  "check_cost": 123,
  "monthly": 123,
  "monthly_resets_at": {},
  "pack": 123,
  "pending": 123,
  "topup": {
    "max_usd": 123,
    "min_usd": 123,
    "tiers": []
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}