> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.finput.com.au/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.finput.com.au/_mcp/server.

# Read the caller's entitlements and usage

GET https://api.finput.com.au/api/v1/billing/entitlements

What this caller's plan allows, plus where they currently stand against the daily calculator budget. A client cannot correctly gate features without this: it is the answer to "may this user run a consumer calculation / open Matrix", and the source of the "X of Y runs used today" affordance.

Refresh the `usage` block after each calculator run rather than counting locally — the cap is enforced server-side and a local count will drift across devices.

Guard the `usage` lookup — do not assume `usage.calc_runs` is present.

`seats` is the caller's organisation against its user limit (`entitlements["org.max_users"]`): active users plus invites not yet accepted. Use it to show "N of M users" and to disable inviting at the limit; the server refuses an add past it with `409 seat_limit_reached` either way. Re-read it after adding or removing a user. It is `null` for a caller with no organisation.

Reference: https://docs.finput.com.au/api/endpoints/billing/get-entitlements

## Authentication

- `Authorization` header (bearer token, required) — JWT access token obtained from `POST /api/v1/auth/login`, or a `finput_sk_...` API token

## Response

### 200

Entitlements and usage.

- `entitlements` (Entitlements, optional) — The caller's effective plan entitlements. Read a missing key as its safe default (`false`, or `0`) rather than assuming the key set is frozen — plans add keys over time.
- `usage` (EntitlementsResponseUsage, optional) — `calc_runs` is not guaranteed present — guard the lookup.
- `seats` (Seats, optional, nullable) — The caller's organisation against its user limit. `null` for a caller with no organisation.

## Errors

### 401 Unauthorized Error

Not authenticated.

- `error` (string, optional)
- `errors` (map from string to list of string, optional)

## Types

### Entitlements

The caller's effective plan entitlements. Read a missing key as its safe default (`false`, or `0`) rather than assuming the key set is frozen — plans add keys over time.

- `calc.runs_per_day` (integer, optional, nullable) — `null` means unlimited.
- `calc.results_full` (boolean, optional)
- `calc.export_enabled` (boolean, optional)
- `calc.consumer_enabled` (boolean, optional)
- `matrix.enabled` (boolean, optional)
- `matrix.runs_per_day` (integer, optional, nullable)
- `org.max_users` (integer, optional, nullable) — Users the organisation may have. `null` means unlimited. Read `seats` on the response for where the organisation stands against it.
- `support.tier` (string, optional)
- `scenarios.max_saved` (integer, optional, nullable) — `null` means unlimited saved scenarios.
- `mcp.enabled` (boolean, optional)

### EntitlementsResponseUsage

`calc_runs` is not guaranteed present — guard the lookup.

- `calc_runs` (CapStatus, optional) — One daily budget. `limit` and `remaining` are `null` when the caller is uncapped.

### Seats

An organisation against its user limit.

- `used` (integer, required) — Active users plus invites not yet accepted. Deactivated users are not counted.
- `limit` (integer, required, nullable) — `null` means unlimited. `used` may exceed it: the limit only refuses adding a user, so an organisation that went over it after a downgrade or trial end keeps everyone.

### CapStatus

One daily budget. `limit` and `remaining` are `null` when the caller is uncapped.

- `limit` (integer, optional, nullable)
- `used` (integer, optional)
- `remaining` (integer, optional, nullable)

## Examples

**Response**

```json
{
  "entitlements": {
    "calc.runs_per_day": 1,
    "calc.results_full": true,
    "calc.export_enabled": true,
    "calc.consumer_enabled": true,
    "matrix.enabled": true,
    "matrix.runs_per_day": 1,
    "org.max_users": 1,
    "support.tier": "string",
    "scenarios.max_saved": 1,
    "mcp.enabled": true
  },
  "usage": {
    "calc_runs": {
      "limit": 1,
      "used": 1,
      "remaining": 1
    }
  },
  "seats": {
    "used": 1,
    "limit": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.finput.com.au/api/v1/billing/entitlements"

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

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

print(response.json())
```

```javascript
const url = 'https://api.finput.com.au/api/v1/billing/entitlements';
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);
}
```

```go
package main

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

func main() {

	url := "https://api.finput.com.au/api/v1/billing/entitlements"

	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))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.finput.com.au/api/v1/billing/entitlements")

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
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.finput.com.au/api/v1/billing/entitlements")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.finput.com.au/api/v1/billing/entitlements', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.finput.com.au/api/v1/billing/entitlements");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.finput.com.au/api/v1/billing/entitlements")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```