Reallocate Credit Limits

Postpaid, individual-billing families only. Sets every active sub-workspace’s credit limit in one call and optionally the family total. The map must name every active sub-workspace exactly once; a slice cannot drop below what that sub-workspace has already used this month, the slices cannot exceed the family total, and what remains for the primary must cover its own usage. Not applicable to common-billing families, where credit is pooled on the primary.

PATCH

workspace

sub

credit-limits

Reallocate Credit Limits

curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "parent_credit_limit": 500000,
  "allocations": {
    "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30": 200000,
    "d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88": 150000
  }
}
'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits"

payload = {
    "parent_credit_limit": 500000,
    "allocations": {
        "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30": 200000,
        "d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88": 150000
    }
}
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    parent_credit_limit: 500000,
    allocations: {
      'b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30': 200000,
      'd21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88': 150000
    }
  })
};

fetch('https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits', 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://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'parent_credit_limit' => 500000,
    'allocations' => [
        'b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30' => 200000,
        'd21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88' => 150000
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <x-api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits"

	payload := strings.NewReader("{\n  \"parent_credit_limit\": 500000,\n  \"allocations\": {\n    \"b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30\": 200000,\n    \"d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88\": 150000\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"parent_credit_limit\": 500000,\n  \"allocations\": {\n    \"b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30\": 200000,\n    \"d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88\": 150000\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"parent_credit_limit\": 500000,\n  \"allocations\": {\n    \"b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30\": 200000,\n    \"d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88\": 150000\n  }\n}"

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

{
  "parent_workspace_id": "2f9a1c44-7e88-4bb1-9a01-5d3c2e7f6a11",
  "parent_credit_limit": "500000.00",
  "allocations": {
    "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30": "200000.00",
    "d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88": "150000.00"
  },
  "primary": {
    "id": "2f9a1c44-7e88-4bb1-9a01-5d3c2e7f6a11",
    "name": "Acme Collections HQ"
  }
}

{
  "detail": "This family uses common billing; per-sub credit limits do not exist."
}

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Invalid credentials"
  }
}

{
  "detail": "Sub-workspaces are not enabled for this workspace."
}

{
  "detail": "Workspace is not a sub-workspace family parent."
}

{
  "error": {
    "code": "500 Internal Server Error",
    "message": "An unexpected error occurred on the server."
  }
}

Set every sub-workspace’s credit limit in one call, and optionally the family total. Postpaid families in individual billing mode only.

When to use

Splitting the family’s credit limit across clients or teams.
Raising one client’s limit at month end while keeping the total unchanged.

Request parameters

Parameter	Type	Required	Description
`allocations`	object	Yes	Map of `sub_workspace_id` to its new credit limit. Must include every active sub-workspace exactly once. Values are absolute, `0` or more, two decimals.
`parent_credit_limit`	number	No	New family total (the primary’s credit limit). Omit to keep the current total.

Rules

A sub-workspace’s limit cannot go below what it has already used this month.
The sum of all allocations cannot exceed the family total. Allocating less than the total is allowed; the remainder stays with the primary.
What remains with the primary must still cover the primary’s own utilized amount.

Integration notes

Authenticate with the primary workspace’s API key.
Read the current limits and usage from Get Sub-workspaces first, then send the full map.
Amounts in the response are decimal strings ("200000.00"), unlike the read endpoints.

In a common-billing family there are no per-sub-workspace limits: every charge utilizes the primary’s single credit limit. This endpoint returns 400 This family uses common billing; per-sub credit limits do not exist. Allocate concurrency instead.

Error responses

400: Credit-limit reallocation applies to postpaid families only.
400: This family uses common billing; per-sub credit limits do not exist.
400: Allocations must cover every active sub-workspace exactly once. Missing: [...]; unknown: [...].
400: Credit limit 100.00 for sub-workspace 'Mumbai Collections' is below its utilized amount 34210.50.
400: The total credit limit across sub-workspaces must not exceed the parent workspace's credit limit (500000.00); allocations sum to 600000.00.
400: These allocations would leave the primary workspace with 1000.00, below its already-utilized 12500.00. Lower the sub-workspace limits or raise the primary credit limit.
401: Invalid or missing API key.
403: Sub-workspaces are not enabled for this workspace.
404: Workspace is not a sub-workspace family parent. — the primary has no sub-workspaces yet.
422: Empty map, negative value, or a key that is not a UUID.

Example

curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits" \
  --header "X-API-KEY: $RINGG_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "parent_credit_limit": 500000.00,
    "allocations": {
      "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30": 200000.00,
      "d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88": 150000.00
    }
  }'

Headers

X-API-KEY

string

required

(Required) The API key of the PRIMARY workspace. A sub-workspace's key is refused with 400.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Body

application/json

allocations

object

required

(Required) sub_workspace_id -> new credit limit. Must include every active sub-workspace exactly once. Values >= 0, two decimals.

Show child attributes

parent_credit_limit

number

(Optional) New family total (the primary's credit limit). Omit to keep the current total.

Required range: x >= 0

Example:

500000

Response

Successful Response: The applied limits. Amounts are decimal strings.

parent_workspace_id

string

Example:

"2f9a1c44-7e88-4bb1-9a01-5d3c2e7f6a11"

parent_credit_limit

string

The family total, as a decimal string.

Example:

"500000.00"

allocations

object

Show child attributes

Example:

{
  "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30": "200000.00",
  "d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88": "150000.00"
}

primary

object

Show child attributes

Reallocate Credit Limits

curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "parent_credit_limit": 500000,
  "allocations": {
    "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30": 200000,
    "d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88": 150000
  }
}
'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits"

payload = {
    "parent_credit_limit": 500000,
    "allocations": {
        "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30": 200000,
        "d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88": 150000
    }
}
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    parent_credit_limit: 500000,
    allocations: {
      'b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30': 200000,
      'd21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88': 150000
    }
  })
};

fetch('https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits', 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://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'parent_credit_limit' => 500000,
    'allocations' => [
        'b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30' => 200000,
        'd21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88' => 150000
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <x-api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits"

	payload := strings.NewReader("{\n  \"parent_credit_limit\": 500000,\n  \"allocations\": {\n    \"b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30\": 200000,\n    \"d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88\": 150000\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"parent_credit_limit\": 500000,\n  \"allocations\": {\n    \"b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30\": 200000,\n    \"d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88\": 150000\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/workspace/sub/credit-limits")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"parent_credit_limit\": 500000,\n  \"allocations\": {\n    \"b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30\": 200000,\n    \"d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88\": 150000\n  }\n}"

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

{
  "parent_workspace_id": "2f9a1c44-7e88-4bb1-9a01-5d3c2e7f6a11",
  "parent_credit_limit": "500000.00",
  "allocations": {
    "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30": "200000.00",
    "d21e8c55-9a0f-4c3b-86de-1f4b7a2c9e88": "150000.00"
  },
  "primary": {
    "id": "2f9a1c44-7e88-4bb1-9a01-5d3c2e7f6a11",
    "name": "Acme Collections HQ"
  }
}

{
  "detail": "This family uses common billing; per-sub credit limits do not exist."
}

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Invalid credentials"
  }
}

{
  "detail": "Sub-workspaces are not enabled for this workspace."
}

{
  "detail": "Workspace is not a sub-workspace family parent."
}

{
  "error": {
    "code": "500 Internal Server Error",
    "message": "An unexpected error occurred on the server."
  }
}

Get Started

API Reference

Webhooks Setup

Telephony Integration

MCP Server

External Integrations

Privacy and Compliance

Reallocate Credit Limits

When to use

Request parameters

Rules

Integration notes

Error responses

Example

Headers

Body

Response

​When to use

​Request parameters

​Rules

​Integration notes

​Error responses

​Example

Headers

Body

Response

When to use

Request parameters

Rules

Integration notes

Error responses

Example