KosmoKrator

data

ChargeOver CLI for AI Agents

Use the ChargeOver CLI from KosmoKrator to call ChargeOver tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

ChargeOver CLI Setup

ChargeOver can be configured headlessly with `kosmokrator integrations:configure chargeover`.

Install, configure, and verify 
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure chargeover --set api_username="$CHARGEOVER_API_USERNAME" --set api_password="$CHARGEOVER_API_PASSWORD" --enable --read allow --write ask --json
kosmokrator integrations:doctor chargeover --json
kosmokrator integrations:status --json

Credentials

Authentication type: basic auth basic_auth. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
api_username CHARGEOVER_API_USERNAME Text string yes API Username
api_password CHARGEOVER_API_PASSWORD Secret secret yes API Password
subdomain CHARGEOVER_SUBDOMAIN Text string no Subdomain
url CHARGEOVER_URL URL url no Custom URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call 
kosmo integrations:call chargeover.chargeover_list_customers '{"limit":1,"offset":1,"where":"example_where","order":"example_order","expand":"example_expand","status":"example_status"}' --json
Provider shortcut 
kosmo integrations:chargeover chargeover_list_customers '{"limit":1,"offset":1,"where":"example_where","order":"example_order","expand":"example_expand","status":"example_status"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands 
kosmo integrations:docs chargeover --json
kosmo integrations:docs chargeover.chargeover_list_customers --json
kosmo integrations:schema chargeover.chargeover_list_customers --json
kosmo integrations:search "ChargeOver" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

chargeover.chargeover_list_customers

List customers from ChargeOver. Supports limit/offset pagination, where filters, sorting, and optional expansion. Use where expressions such as company:CONTAINS:acme or customer_status_state:EQUALS:a.

Read read
Parameters
limit, offset, where, order, expand, status
Generic call 
kosmo integrations:call chargeover.chargeover_list_customers '{"limit":1,"offset":1,"where":"example_where","order":"example_order","expand":"example_expand","status":"example_status"}' --json
Shortcut 
kosmo integrations:chargeover chargeover_list_customers '{"limit":1,"offset":1,"where":"example_where","order":"example_order","expand":"example_expand","status":"example_status"}' --json

chargeover.chargeover_get_customer

Get detailed information about a specific ChargeOver customer by ID, including contact details, billing address, account balance, and payment methods.

Read read
Parameters
id
Generic call 
kosmo integrations:call chargeover.chargeover_get_customer '{"id":1}' --json
Shortcut 
kosmo integrations:chargeover chargeover_get_customer '{"id":1}' --json

chargeover.chargeover_list_subscriptions

List ChargeOver subscriptions, which the API exposes as package records at /api/v3/package. Supports customer filtering plus where/order/expand query parameters.

Read read
Parameters
limit, offset, customer_id, where, order, expand
Generic call 
kosmo integrations:call chargeover.chargeover_list_subscriptions '{"limit":1,"offset":1,"customer_id":1,"where":"example_where","order":"example_order","expand":"example_expand"}' --json
Shortcut 
kosmo integrations:chargeover chargeover_list_subscriptions '{"limit":1,"offset":1,"customer_id":1,"where":"example_where","order":"example_order","expand":"example_expand"}' --json

chargeover.chargeover_list_invoices

List invoices from ChargeOver. Supports limit/offset pagination, where filters such as date:GTE:2026-01-01, sorting, and optional expansion.

Read read
Parameters
limit, offset, where, order, expand, status
Generic call 
kosmo integrations:call chargeover.chargeover_list_invoices '{"limit":1,"offset":1,"where":"example_where","order":"example_order","expand":"example_expand","status":"example_status"}' --json
Shortcut 
kosmo integrations:chargeover chargeover_list_invoices '{"limit":1,"offset":1,"where":"example_where","order":"example_order","expand":"example_expand","status":"example_status"}' --json

chargeover.chargeover_get_invoice

Get detailed information about a specific ChargeOver invoice by ID, including line items, totals, tax, applied payments, and invoice URL.

Read read
Parameters
id
Generic call 
kosmo integrations:call chargeover.chargeover_get_invoice '{"id":1}' --json
Shortcut 
kosmo integrations:chargeover chargeover_get_invoice '{"id":1}' --json

chargeover.chargeover_list_transactions

List transactions from ChargeOver, including payments, refunds, and credits. Supports limit/offset pagination, where filters, sorting, and applied_to expansion.

Read read
Parameters
limit, offset, where, order, expand
Generic call 
kosmo integrations:call chargeover.chargeover_list_transactions '{"limit":1,"offset":1,"where":"example_where","order":"example_order","expand":"example_expand"}' --json
Shortcut 
kosmo integrations:chargeover chargeover_list_transactions '{"limit":1,"offset":1,"where":"example_where","order":"example_order","expand":"example_expand"}' --json

chargeover.chargeover_get_transaction

Get detailed information about a specific ChargeOver transaction by transaction_id.

Read read
Parameters
id
Generic call 
kosmo integrations:call chargeover.chargeover_get_transaction '{"id":1}' --json
Shortcut 
kosmo integrations:chargeover chargeover_get_transaction '{"id":1}' --json

chargeover.chargeover_get_current_user

Verify ChargeOver API access with a lightweight authenticated customer query. ChargeOver does not expose a dedicated /me endpoint in REST API v3.

Read read
Parameters
none
Generic call 
kosmo integrations:call chargeover.chargeover_get_current_user '{}' --json
Shortcut 
kosmo integrations:chargeover chargeover_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

chargeover.chargeover_list_customers 6 parameters
Schema command 
kosmo integrations:schema chargeover.chargeover_list_customers --json
ParameterTypeRequiredDescription
limit integer no Number of customers to return per page (default: 10, max: 500).
offset integer no Record offset for pagination (default: 0).
where string no ChargeOver where expression, e.g. superuser_email:EQUALS:person@example.test.
order string no Sort expression, e.g. customer_id:DESC.
expand string no Optional ChargeOver expand value when supported by the endpoint.
status string no Legacy shortcut for customer_status_state; use "a" for active or "i" for inactive.
chargeover.chargeover_get_customer 1 parameters
Schema command 
kosmo integrations:schema chargeover.chargeover_get_customer --json
ParameterTypeRequiredDescription
id integer yes The customer ID.
chargeover.chargeover_list_subscriptions 6 parameters
Schema command 
kosmo integrations:schema chargeover.chargeover_list_subscriptions --json
ParameterTypeRequiredDescription
limit integer no Number of subscriptions to return per page (default: 10, max: 500).
offset integer no Record offset for pagination (default: 0).
customer_id integer no Filter subscriptions by customer ID.
where string no ChargeOver where expression, e.g. package_status_state:EQUALS:a.
order string no Sort expression, e.g. package_id:DESC.
expand string no Optional expansion such as line_items.
chargeover.chargeover_list_invoices 6 parameters
Schema command 
kosmo integrations:schema chargeover.chargeover_list_invoices --json
ParameterTypeRequiredDescription
limit integer no Number of invoices to return per page (default: 10, max: 500).
offset integer no Record offset for pagination (default: 0).
where string no ChargeOver where expression, e.g. invoice_status_state:EQUALS:o or date:GTE:2026-01-01.
order string no Sort expression, e.g. invoice_id:DESC or total:ASC.
expand string no Optional ChargeOver expand value when supported by the endpoint.
status string no Legacy shortcut mapped to invoice_status_state:EQUALS:{status}.
chargeover.chargeover_get_invoice 1 parameters
Schema command 
kosmo integrations:schema chargeover.chargeover_get_invoice --json
ParameterTypeRequiredDescription
id integer yes The invoice ID.
chargeover.chargeover_list_transactions 5 parameters
Schema command 
kosmo integrations:schema chargeover.chargeover_list_transactions --json
ParameterTypeRequiredDescription
limit integer no Number of transactions to return per page (default: 10, max: 500).
offset integer no Record offset for pagination (default: 0).
where string no ChargeOver where expression, e.g. transaction_status.state:EQUALS:succeeded.
order string no Sort expression, e.g. transaction_id:DESC.
expand string no Optional expansion such as applied_to.
chargeover.chargeover_get_transaction 1 parameters
Schema command 
kosmo integrations:schema chargeover.chargeover_get_transaction --json
ParameterTypeRequiredDescription
id integer yes The ChargeOver transaction_id.
chargeover.chargeover_get_current_user 0 parameters
Schema command 
kosmo integrations:schema chargeover.chargeover_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.