Update sub-organization billing config

PATCH

orgs

{sub_org_id}

billing

curl --request PATCH \
  --url https://api.useinvent.com/orgs/orgs/{sub_org_id}/billing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_recharge": {
    "enabled": true,
    "recharge_threshold": 252.5,
    "recharge_amount": 252.5
  },
  "use_parent_balance": true
}
'

import requests

url = "https://api.useinvent.com/orgs/orgs/{sub_org_id}/billing"

payload = {
    "auto_recharge": {
        "enabled": True,
        "recharge_threshold": 252.5,
        "recharge_amount": 252.5
    },
    "use_parent_balance": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    auto_recharge: {enabled: true, recharge_threshold: 252.5, recharge_amount: 252.5},
    use_parent_balance: true
  })
};

fetch('https://api.useinvent.com/orgs/orgs/{sub_org_id}/billing', 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://api.useinvent.com/orgs/orgs/{sub_org_id}/billing",
  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([
    'auto_recharge' => [
        'enabled' => true,
        'recharge_threshold' => 252.5,
        'recharge_amount' => 252.5
    ],
    'use_parent_balance' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.useinvent.com/orgs/orgs/{sub_org_id}/billing"

	payload := strings.NewReader("{\n  \"auto_recharge\": {\n    \"enabled\": true,\n    \"recharge_threshold\": 252.5,\n    \"recharge_amount\": 252.5\n  },\n  \"use_parent_balance\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.useinvent.com/orgs/orgs/{sub_org_id}/billing")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_recharge\": {\n    \"enabled\": true,\n    \"recharge_threshold\": 252.5,\n    \"recharge_amount\": 252.5\n  },\n  \"use_parent_balance\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/orgs/orgs/{sub_org_id}/billing")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auto_recharge\": {\n    \"enabled\": true,\n    \"recharge_threshold\": 252.5,\n    \"recharge_amount\": 252.5\n  },\n  \"use_parent_balance\": true\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "verified": true,
  "disabled": true,
  "type": "PERSONAL",
  "plan": "free",
  "balance": 123,
  "promo_balance": 123,
  "promo_balance_reset_at": "2023-11-07T05:31:56Z",
  "billing": {
    "auto_recharge": {
      "enabled": true,
      "recharge_threshold": 252.5,
      "recharge_amount": 252.5
    },
    "use_parent_balance": true,
    "spending_cap": {
      "enabled": true,
      "amount": 50000,
      "reset_at": "2023-11-07T05:31:56Z",
      "defaults": {
        "user": 50000,
        "agent": 50000,
        "assistant": 50000
      }
    },
    "payment_method": {
      "type": "<string>",
      "payment_method_id": "<string>",
      "brand": "<string>",
      "last4": "<string>",
      "email": "<string>",
      "inactive": true,
      "off_session_unsupported": true,
      "failed_at": "2023-11-07T05:31:56Z",
      "failed_message": "<string>"
    },
    "last_low_balance_notification_at": "2023-11-07T05:31:56Z",
    "last_out_of_balance_notification_at": "2023-11-07T05:31:56Z",
    "last_spending_cap_notification_at": "2023-11-07T05:31:56Z",
    "last_cancellation_notification_at": "2023-11-07T05:31:56Z"
  },
  "logo_url": "<string>",
  "deleted": true,
  "spending_cap_used": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "role": "ADMIN",
  "permissions": [
    "org:write"
  ],
  "is_member": true,
  "features": {
    "enterprise": true,
    "allow_overdraft": true,
    "workflows": true,
    "enable_japifon": true,
    "enable_smpp": true,
    "pages": true,
    "slack_access": true,
    "emails": true,
    "templates": true,
    "voice": true,
    "meta_agent": true,
    "meta_conversions": true
  },
  "config": {
    "email": "jsmith@example.com",
    "address": "<string>",
    "terms_url": "<string>",
    "privacy_url": "<string>",
    "access": {
      "session_ttl_seconds": 0,
      "allow_google": true,
      "allow_microsoft": true,
      "allow_apple": true,
      "allow_email_code": true,
      "allow_invites": true
    },
    "modules": {
      "enable_org_chats": true,
      "enable_inbox": true,
      "enable_analytics": true,
      "enable_assistants": true,
      "enable_agents": true,
      "enable_knowledge_base": true,
      "enable_broadcasts": true,
      "enable_channels": true,
      "enable_workflows": true,
      "enable_audience": true,
      "enable_tables": true,
      "enable_pages": true,
      "enable_balance_credits": true
    }
  },
  "parent_org": {
    "id": "<string>",
    "name": "<string>",
    "verified": true,
    "logo_url": "<string>",
    "plan": "free",
    "config": {
      "email": "jsmith@example.com",
      "address": "<string>",
      "terms_url": "<string>",
      "privacy_url": "<string>",
      "access": {
        "session_ttl_seconds": 0,
        "allow_google": true,
        "allow_microsoft": true,
        "allow_apple": true,
        "allow_email_code": true,
        "allow_invites": true
      },
      "modules": {
        "enable_org_chats": true,
        "enable_inbox": true,
        "enable_analytics": true,
        "enable_assistants": true,
        "enable_agents": true,
        "enable_knowledge_base": true,
        "enable_broadcasts": true,
        "enable_channels": true,
        "enable_workflows": true,
        "enable_audience": true,
        "enable_tables": true,
        "enable_pages": true,
        "enable_balance_credits": true
      }
    },
    "features": {
      "enterprise": true,
      "allow_overdraft": true,
      "workflows": true,
      "enable_japifon": true,
      "enable_smpp": true,
      "pages": true,
      "slack_access": true,
      "emails": true,
      "templates": true,
      "voice": true,
      "meta_agent": true,
      "meta_conversions": true
    },
    "subscription_available": true,
    "parent_org_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication using your API key

Path Parameters

sub_org_id

string

required

The ID of the sub-organization

Body

Schema for updating payment configuration

auto_recharge

object

required

Show child attributes

use_parent_balance

boolean

Use the parent balance when it's a sub-org

spending_cap

Spending Limit · object

Monthly spending limit

Show child attributes

Response

200 - application/json

The sub-organization with updated billing config.

Detailed information about an org (organization)

string

required

Unique identifier for the org

name

string

required

Name of the org

verified

boolean

required

Verification status of the org

disabled

boolean

required

Whether the org is disabled by the system

type

enum<string>

required

Type of the organization

Available options:

PERSONAL,

TEAM

plan

enum<string>

required

Type of subscription plan

Available options:

free,

business

balance

number

required

Current balance of the org

Current promotional balance of the org

Timestamp when the promotional balance was last reset

billing

object

required

Schema for updating payment configuration

Show child attributes

logo_url

string | null

required

URL of the organization logo

deleted

boolean

required

Deletion status of the org

spending_cap_used

number

required

Amount spent in the current month against the spending cap

created_at

string<date-time> | null

required

Timestamp when the org was created

updated_at

string<date-time> | null

required

Timestamp when the org was last updated

role

enum<string>

A system role

Available options:

ADMIN,

DEVELOPER,

MANAGER,

STAFF

permissions

enum<string>[]

Effective permissions of the current user within the organization (* = full admin access)

A member's effective org permission: a resource:action, or * for full (admin) access.

Available options:

org:write,

admin:write,

members:read,

members:invite,

members:write,

members.roles.system:write,

inbox:read,

inbox:write,

analytics:read,

contacts:read,

contacts:write,

segments:write,

broadcasts:read,

broadcasts:write,

assistants:read,

assistants:write,

assistants.members:write,

agents:read,

agents:write,

routines:read,

routines:write,

knowledge:read,

knowledge:write,

skills:read,

skills:write,

workflows:write,

connections:write,

keys:write,

webhooks:write,

tables:read,

tables:write,

tables.records:write,

tables.views:write,

pages:read,

pages:write,

audit_logs:read,

sso:write,

domains:write,

emails:write,

billing:write,

variables:write,

templates:write,

orgs:write,

*

is_member

boolean

Whether the current user has their own member row in this organization. false means they only reach it as an admin of its parent org — role is inherited in that case.

features

object

Org gate-keeping features configuration

Show child attributes

config

object

Organization configuration settings

Show child attributes

parent_org

object

Public information about an org (organization)

Show child attributes

Update sub-organization billing config

curl --request PATCH \
  --url https://api.useinvent.com/orgs/orgs/{sub_org_id}/billing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_recharge": {
    "enabled": true,
    "recharge_threshold": 252.5,
    "recharge_amount": 252.5
  },
  "use_parent_balance": true
}
'

import requests

url = "https://api.useinvent.com/orgs/orgs/{sub_org_id}/billing"

payload = {
    "auto_recharge": {
        "enabled": True,
        "recharge_threshold": 252.5,
        "recharge_amount": 252.5
    },
    "use_parent_balance": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    auto_recharge: {enabled: true, recharge_threshold: 252.5, recharge_amount: 252.5},
    use_parent_balance: true
  })
};

fetch('https://api.useinvent.com/orgs/orgs/{sub_org_id}/billing', 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://api.useinvent.com/orgs/orgs/{sub_org_id}/billing",
  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([
    'auto_recharge' => [
        'enabled' => true,
        'recharge_threshold' => 252.5,
        'recharge_amount' => 252.5
    ],
    'use_parent_balance' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.useinvent.com/orgs/orgs/{sub_org_id}/billing"

	payload := strings.NewReader("{\n  \"auto_recharge\": {\n    \"enabled\": true,\n    \"recharge_threshold\": 252.5,\n    \"recharge_amount\": 252.5\n  },\n  \"use_parent_balance\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.useinvent.com/orgs/orgs/{sub_org_id}/billing")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_recharge\": {\n    \"enabled\": true,\n    \"recharge_threshold\": 252.5,\n    \"recharge_amount\": 252.5\n  },\n  \"use_parent_balance\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/orgs/orgs/{sub_org_id}/billing")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auto_recharge\": {\n    \"enabled\": true,\n    \"recharge_threshold\": 252.5,\n    \"recharge_amount\": 252.5\n  },\n  \"use_parent_balance\": true\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "verified": true,
  "disabled": true,
  "type": "PERSONAL",
  "plan": "free",
  "balance": 123,
  "promo_balance": 123,
  "promo_balance_reset_at": "2023-11-07T05:31:56Z",
  "billing": {
    "auto_recharge": {
      "enabled": true,
      "recharge_threshold": 252.5,
      "recharge_amount": 252.5
    },
    "use_parent_balance": true,
    "spending_cap": {
      "enabled": true,
      "amount": 50000,
      "reset_at": "2023-11-07T05:31:56Z",
      "defaults": {
        "user": 50000,
        "agent": 50000,
        "assistant": 50000
      }
    },
    "payment_method": {
      "type": "<string>",
      "payment_method_id": "<string>",
      "brand": "<string>",
      "last4": "<string>",
      "email": "<string>",
      "inactive": true,
      "off_session_unsupported": true,
      "failed_at": "2023-11-07T05:31:56Z",
      "failed_message": "<string>"
    },
    "last_low_balance_notification_at": "2023-11-07T05:31:56Z",
    "last_out_of_balance_notification_at": "2023-11-07T05:31:56Z",
    "last_spending_cap_notification_at": "2023-11-07T05:31:56Z",
    "last_cancellation_notification_at": "2023-11-07T05:31:56Z"
  },
  "logo_url": "<string>",
  "deleted": true,
  "spending_cap_used": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "role": "ADMIN",
  "permissions": [
    "org:write"
  ],
  "is_member": true,
  "features": {
    "enterprise": true,
    "allow_overdraft": true,
    "workflows": true,
    "enable_japifon": true,
    "enable_smpp": true,
    "pages": true,
    "slack_access": true,
    "emails": true,
    "templates": true,
    "voice": true,
    "meta_agent": true,
    "meta_conversions": true
  },
  "config": {
    "email": "jsmith@example.com",
    "address": "<string>",
    "terms_url": "<string>",
    "privacy_url": "<string>",
    "access": {
      "session_ttl_seconds": 0,
      "allow_google": true,
      "allow_microsoft": true,
      "allow_apple": true,
      "allow_email_code": true,
      "allow_invites": true
    },
    "modules": {
      "enable_org_chats": true,
      "enable_inbox": true,
      "enable_analytics": true,
      "enable_assistants": true,
      "enable_agents": true,
      "enable_knowledge_base": true,
      "enable_broadcasts": true,
      "enable_channels": true,
      "enable_workflows": true,
      "enable_audience": true,
      "enable_tables": true,
      "enable_pages": true,
      "enable_balance_credits": true
    }
  },
  "parent_org": {
    "id": "<string>",
    "name": "<string>",
    "verified": true,
    "logo_url": "<string>",
    "plan": "free",
    "config": {
      "email": "jsmith@example.com",
      "address": "<string>",
      "terms_url": "<string>",
      "privacy_url": "<string>",
      "access": {
        "session_ttl_seconds": 0,
        "allow_google": true,
        "allow_microsoft": true,
        "allow_apple": true,
        "allow_email_code": true,
        "allow_invites": true
      },
      "modules": {
        "enable_org_chats": true,
        "enable_inbox": true,
        "enable_analytics": true,
        "enable_assistants": true,
        "enable_agents": true,
        "enable_knowledge_base": true,
        "enable_broadcasts": true,
        "enable_channels": true,
        "enable_workflows": true,
        "enable_audience": true,
        "enable_tables": true,
        "enable_pages": true,
        "enable_balance_credits": true
      }
    },
    "features": {
      "enterprise": true,
      "allow_overdraft": true,
      "workflows": true,
      "enable_japifon": true,
      "enable_smpp": true,
      "pages": true,
      "slack_access": true,
      "emails": true,
      "templates": true,
      "voice": true,
      "meta_agent": true,
      "meta_conversions": true
    },
    "subscription_available": true,
    "parent_org_id": "<string>"
  }
}

Getting Started

Inbox

Chats

Messages

Contacts

Custom channels

Segments

Suppressions

Assistants

Agents

Skills

Knowledge

AI

Broadcasts

Email sending

WhatsApp

WhatsApp Meta agent

Tables

Records

Views

Pages

Connections

Workspace

Sub-organizations

Analytics and logs

Update sub-organization billing config

Authorizations

Path Parameters

Body

Response