> For the documentation index, fetch https://sync.so/docs/llms.txt. Append .md to a page URL for Markdown. Documentation-search MCP: https://sync.so/docs/_mcp/server.

# Get Account

GET https://api.sync.so/v2/account

Get the account, plan, limits and balance behind these credentials. Call it before submitting work to check plan limits and remaining credits or free allowance, and after a 402, 403 or 429 to decide how to recover: `billingModel` says whether to top up credits (`credits`), pay or update the payment method (`usage`), upgrade (`free`) or contact sync. (`enterprise`). Send people to `billingUrl` for anything that needs a payment.

Reference: https://sync.so/docs/api-reference/api/account-api/get

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://api.sync.so` (Default, default)
- `https://dev-api.sync.so` (dev)
- `http://localhost:3001` (local)

## Response

### 200

Account, organization, plan, limits and balance

- `account` (AccountUser, required, nullable) — The user this credential acts for: the signed-in user for sessions and OAuth tokens, or the API key owner. Null for an API key that has no owner.
- `organization` (AccountOrganization, required) — The organization every request with this credential acts in.
- `credentialType` (enum, required) — `api_key`: an x-api-key header. `oauth`: an access token issued to a connected app such as an MCP client. `session`: a Studio sign-in.
  - Allowed values: `api_key`, `oauth`, `session`
- `plan` (AccountPlan, required) — Current plan.
- `billingModel` (enum, required) — How generations are paid for, which decides how to recover from a 402. `credits`: prepaid credits; top up, turn on auto top-up or upgrade at billingUrl. `usage`: usage is metered and invoiced; pay the open invoice or update the payment method at billingUrl. `free`: a monthly free allowance; upgrade at billingUrl. `enterprise`: negotiated billing; contact your sync. account team.
  - Allowed values: `credits`, `usage`, `free`, `enterprise`
- `limits` (AccountLimits, required) — Current plan limits, including organization overrides.
- `activeJobs` (AccountActiveJobs, required) — Jobs pending or processing right now. May be up to a few seconds stale.
- `credits` (AccountCredits, required, nullable) — Prepaid credit balance when billingModel is `credits`; null otherwise.
- `billingPeriod` (AccountBillingPeriod, required) — Current billing period. Without a subscription this is the calendar month.
- `freeAllowance` (AccountFreeAllowance, required, nullable) — Free monthly allowance when billingModel is `free`; null otherwise.
- `billingUrl` (string, required) — Studio billing page where a person can change plan, pay, top up or update the payment method. It needs a signed-in browser.

## Errors

### 401 Unauthorized Error

Unauthorized - Invalid or missing authentication

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission or a DUPLICATE_SUBMISSION. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.
- `lineNumber` (integer, optional) — For batch creation, on dialogue edit refusals only: the 1-based line of the refused record, counting non-empty JSONL lines. With a `rows` body, line N is `rows[N-1]`. Other record errors name the line only in `message`.

### 500 Internal Server Error

Internal Server Error - An unexpected failure on our side. The body carries errorCode internal_error and a requestId; include the requestId when contacting support.

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission or a DUPLICATE_SUBMISSION. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.
- `lineNumber` (integer, optional) — For batch creation, on dialogue edit refusals only: the 1-based line of the refused record, counting non-empty JSONL lines. With a `rows` body, line N is `rows[N-1]`. Other record errors name the line only in `message`.

## Types

### AccountUser

- `id` (string, required)
- `email` (string, required, nullable)
- `name` (string, required, nullable)

### AccountOrganization

- `id` (string, required)
- `name` (string, required, nullable)
- `role` (string, required) — Role the credential acts with: owner, admin or member. API keys always act as member.

### AccountPlan

- `id` (string, required) — Stable plan identifier, such as `free`, `hobbyist`, `creator`, `growth`, `scale`, `enterprise`, or a credit plan (`hobby`, `starter`, `pro`, `team`). `free` means no paid plan.
- `name` (string, required) — Plan name to show a person.

### AccountLimits

- `concurrency` (integer, required) — Lipsync generations that can run at once. Further submissions get 429 concurrency_limit_reached until one finishes.
- `maxOutputDurationSeconds` (double, required) — Longest output a generation may produce on this plan, in seconds. Some models have a lower limit (GET /v2/models).
- `maxFileSizeBytes` (long, required) — Largest input file the plan accepts, in bytes.
- `voiceClones` (integer, required) — Cloned voices the organization can keep at once.

### AccountActiveJobs

- `generations` (integer, required) — In-flight video lipsync generations. Compare with limits.concurrency; batch generations are included here and count toward it only below the Scale plan.
- `total` (integer, required) — All in-flight jobs, including dubbing and text-to-speech. Not a limit.

### AccountCredits

- `available` (double, required) — Credits that can be spent now: the balance minus credits reserved by in-flight jobs. 1 credit = $0.01.
- `periodGrant` (double, required) — Credits the plan grants each billing period.
- `autoTopUp` (boolean, required) — Whether credits are bought automatically when the balance runs low.

### AccountBillingPeriod

- `start` (datetime, required)
- `end` (datetime, required)

### AccountFreeAllowance

- `generations` (AccountAllowanceUsage, required) — Free lipsync generations. In-flight generations count as used.
- `speech` (AccountAllowanceUsage, required) — Free text-to-speech and dubbing jobs, which share one pool.
- `resetsAt` (datetime, required) — When the free month resets. It is anchored to the day the organization was created.

### GenerationErrorMessage

A message describing the error.

- string
- list of string

### DialogueEditRetimeFailureSection

The dialogue-edit section that removes too much speech to stay in sync.

- `slotIndex` (integer, required) — Zero-based index of the section in the preview's `resultSlots`.
- `sourceStartMs` (integer, optional) — Start of the section in the source video, in absolute milliseconds.
- `sourceDurationMs` (integer, optional) — Length of the section in the source video, in milliseconds.

### AccountAllowanceUsage

- `used` (integer, required) — Uses counted in the current free month.
- `limit` (integer, required) — Uses included each free month.
- `remaining` (integer, required) — Uses left this free month (limit minus used, never below 0).

## Examples

**Response**

```json
{
  "account": {
    "id": "1c3a7c1e-9f2b-4e7a-9a53-1f0c3b2d4e5f",
    "email": "dev@example.com",
    "name": "Dev"
  },
  "organization": {
    "id": "6d2f4b8a-1e3c-4a5b-9c7d-8e9f0a1b2c3d",
    "name": "Example Inc.",
    "role": "member"
  },
  "credentialType": "api_key",
  "plan": {
    "id": "creator",
    "name": "Creator"
  },
  "billingModel": "usage",
  "limits": {
    "concurrency": 3,
    "maxOutputDurationSeconds": 300,
    "maxFileSizeBytes": 2684354560,
    "voiceClones": 5
  },
  "activeJobs": {
    "generations": 1,
    "total": 1
  },
  "billingPeriod": {
    "start": "2026-11-01T00:00:00Z",
    "end": "2026-12-01T00:00:00Z"
  },
  "billingUrl": "https://sync.so/billing/subscription"
}
```

**SDK Code**

```python
import requests

url = "https://api.sync.so/v2/account"

headers = {"x-api-key": "<apiKey>"}

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

print(response.json())
```

```javascript
const url = 'https://api.sync.so/v2/account';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

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.sync.so/v2/account"

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

	req.Header.Add("x-api-key", "<apiKey>")

	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.sync.so/v2/account")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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.sync.so/v2/account")
  .header("x-api-key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sync.so/v2/account', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/account");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/account")! 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()
```