Current subscription tier

Returns the user’s current Audity subscription tier. Use this to predict whether a tier-gated operation will succeed before calling it. Public pricing names can change faster than API enum names, so use this endpoint and any requiredTier field in 403 responses as the source of truth for a specific account.

Response: { success: true, tier: 'starter', userId: 'user_...' }.

GET /api/user/tier

Current subscription tier

cURL

curl --request GET \
  --url https://app.auditynow.com/api/user/tier \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.auditynow.com/api/user/tier"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.auditynow.com/api/user/tier', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.auditynow.com/api/user/tier",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.auditynow.com/api/user/tier"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.auditynow.com/api/user/tier")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/user/tier")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "tier": "starter",
  "userId": "user_2abc123XYZ"
}

{
  "error": "Unauthorized"
}

Authorizations

Authorization · string · header · required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Response

200

application/json

Current tier

tier · enum<string> · required

Available options: solo, starter, growth, agency

success · boolean

userId · string