Get the billing summary

GET

/api/v1/billing

Requires the admin role.

Authorizations

bearerAuth

Responses

200

Billing summary

Response body

application/json

object

subscription

object

active

boolean

credit_billed

boolean

credits_remaining

number | null

seats

object

purchased

integer

used

integer

available

integer

questions_this_month

integer

monthly_usage

Array<object>

object

label

string

key

string

credits_used

number

questions

integer

403

Insufficient scope, role, or credits

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request GET \
  --url https://app.responsehub.io/api/v1/billing \
  --header 'Authorization: Bearer <token>'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/billing")

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

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.responsehub.io/api/v1/billing', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/billing';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

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

func main() {

  url := "https://app.responsehub.io/api/v1/billing"

  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(res)
  fmt.Println(string(body))

}

200example

Example^generated

{
  "subscription": {
    "active": true,
    "credit_billed": true
  },
  "credits_remaining": 1,
  "seats": {
    "purchased": 1,
    "used": 1,
    "available": 1
  },
  "questions_this_month": 1,
  "monthly_usage": [
    {
      "label": "example",
      "key": "example",
      "credits_used": 1,
      "questions": 1
    }
  ]
}

403example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}