> This page is for Workspace app.

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

# Plan, credit balance, grants and recent usage

GET https://api.cloudraker.com/billing/plan-view

The plan and usage summary the Settings → Billing screen renders. Its `rates` come from the advertised catalog and carry a price for every row — for the plan’s own credit price list, including the meters it does not price, read `GET /api/billing/rates`. Authorization: any member of the organization.

Reference: https://docs.cloudraker.com/workspace/api/billing/get-billing-plan-view

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Response

### 200

The organization’s plan view.

- `plan` (BillingPlanViewResponsePlan, required)
- `balance` (BillingPlanViewResponseBalance, required)
- `aiWallet` (BillingPlanViewResponseAiWallet, required)
- `credits` (BillingPlanViewResponseCredits, required)
- `rates` (list of BillingPlanViewResponseRatesItems, required)
- `grants` (list of BillingPlanViewResponseGrantsItems, required)
- `usage` (list of BillingPlanViewResponseUsageItems, required)

## Errors

### 503 Service Unavailable Error

`not_configured` — billing is not wired in this environment; `metering_unavailable` — the billing service did not answer.

- `error` (enum, required)
  - Allowed values: `not_configured`, `metering_unavailable`

## Types

### BillingPlanViewResponsePlan

- `name` (string, required, nullable)

### BillingPlanViewResponseBalance

- `settled` (double, required)
- `granted` (double, required)
- `creditValueUsd` (double, required)

### BillingPlanViewResponseAiWallet

- `settled` (double, required)
- `granted` (double, required)
- `creditValueUsd` (double, required)
- `recharged` (boolean, required)

### BillingPlanViewResponseCredits

- `balance` (double, required)
- `held` (double, required)
- `currency` (string, required)

### BillingPlanViewResponseRatesItems

- `feature` (string, required)
- `unit` (string, required)
- `credits` (double, required)

### BillingPlanViewResponseGrantsItems

- `reason` (string, required, nullable)
- `granted` (double, required)
- `remaining` (double, required)
- `grantedAt` (string, required)
- `expiresAt` (string, required, nullable)

### BillingPlanViewResponseUsageItems

- `at` (string, required)
- `event` (string, required, nullable)
- `feature` (string, required, nullable)
- `quantity` (double, required)
- `credits` (double, required, nullable)
- `dimensions` (map from string to BillingPlanViewResponseUsageItemsDimensions, optional)

### BillingPlanViewResponseUsageItemsDimensions

- string
- double
- boolean

## Examples

**Response**

```json
{
  "plan": {
    "name": "Free"
  },
  "balance": {
    "settled": 19940,
    "granted": 20000,
    "creditValueUsd": 0.001
  },
  "aiWallet": {
    "settled": 1000,
    "granted": 1025,
    "creditValueUsd": 0.01,
    "recharged": true
  },
  "credits": {
    "balance": 49716.547,
    "held": 22.5,
    "currency": "credits"
  },
  "rates": [
    {
      "feature": "Parse — Simple Page",
      "unit": "page",
      "credits": 5
    }
  ],
  "grants": [
    {
      "reason": "plan",
      "granted": 20000,
      "remaining": 19940,
      "grantedAt": "2026-07-26T17:41:42Z",
      "expiresAt": "2027-07-26T17:41:42Z"
    }
  ],
  "usage": [
    {
      "at": "2026-07-25T12:00:00Z",
      "event": "page_extracted",
      "feature": "Extraction — Smart",
      "quantity": 3,
      "credits": -45,
      "dimensions": {}
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/billing/plan-view"

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

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

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/billing/plan-view';
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.cloudraker.com/billing/plan-view"

	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.cloudraker.com/billing/plan-view")

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.cloudraker.com/billing/plan-view")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.cloudraker.com/billing/plan-view', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/billing/plan-view");
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.cloudraker.com/billing/plan-view")! 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()
```