KosmoKrator

payments

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.

7 functions 7 read 0 write Bearer token auth

ChargeOver CLI Setup

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

# 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 access_token="$CHARGEOVER_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor chargeover --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

KeyEnv varTypeRequiredLabel
access_token CHARGEOVER_ACCESS_TOKEN Secret secret yes Access Token
subdomain CHARGEOVER_SUBDOMAIN Text string no Subdomain
url CHARGEOVER_URL URL url no Custom URL

Call ChargeOver Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call chargeover.chargeover_list_customers '{
  "limit": 1,
  "page": 1,
  "status": "example_status"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:chargeover chargeover_list_customers '{
  "limit": 1,
  "page": 1,
  "status": "example_status"
}' --json

Agent Discovery Commands

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

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

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to ChargeOver.

chargeover.chargeover_list_customers

Read read

List customers from ChargeOver. Returns customer records with contact details, company info, and account status. Supports pagination and status filtering.

Parameters
limit, page, status

Generic CLI call

kosmo integrations:call chargeover.chargeover_list_customers '{"limit":1,"page":1,"status":"example_status"}' --json

Provider shortcut

kosmo integrations:chargeover chargeover_list_customers '{"limit":1,"page":1,"status":"example_status"}' --json

chargeover.chargeover_get_customer

Read read

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

Parameters
id

Generic CLI call

kosmo integrations:call chargeover.chargeover_get_customer '{"id":1}' --json

Provider shortcut

kosmo integrations:chargeover chargeover_get_customer '{"id":1}' --json

chargeover.chargeover_list_subscriptions

Read read

List subscriptions from ChargeOver. Returns subscription details including plan, billing cycle, status, and associated customer. Supports filtering by customer.

Parameters
limit, page, customer_id

Generic CLI call

kosmo integrations:call chargeover.chargeover_list_subscriptions '{"limit":1,"page":1,"customer_id":1}' --json

Provider shortcut

kosmo integrations:chargeover chargeover_list_subscriptions '{"limit":1,"page":1,"customer_id":1}' --json

chargeover.chargeover_list_invoices

Read read

List invoices from ChargeOver. Returns invoice details including amounts, dates, line items, and payment status. Supports pagination and status filtering.

Parameters
limit, page, status

Generic CLI call

kosmo integrations:call chargeover.chargeover_list_invoices '{"limit":1,"page":1,"status":"example_status"}' --json

Provider shortcut

kosmo integrations:chargeover chargeover_list_invoices '{"limit":1,"page":1,"status":"example_status"}' --json

chargeover.chargeover_get_invoice

Read read

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

Parameters
id

Generic CLI call

kosmo integrations:call chargeover.chargeover_get_invoice '{"id":1}' --json

Provider shortcut

kosmo integrations:chargeover chargeover_get_invoice '{"id":1}' --json

chargeover.chargeover_list_transactions

Read read

List transactions (payments) from ChargeOver. Returns payment records including amounts, methods, dates, and associated customers and invoices.

Parameters
limit, page

Generic CLI call

kosmo integrations:call chargeover.chargeover_list_transactions '{"limit":1,"page":1}' --json

Provider shortcut

kosmo integrations:chargeover chargeover_list_transactions '{"limit":1,"page":1}' --json

chargeover.chargeover_get_current_user

Read read

Get information about the currently authenticated ChargeOver user and account. Useful for verifying connectivity and understanding which account the integration is connected to.

Parameters
none

Generic CLI call

kosmo integrations:call chargeover.chargeover_get_current_user '{}' --json

Provider 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

List customers from ChargeOver. Returns customer records with contact details, company info, and account status. Supports pagination and status filtering.

Operation
Read read
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).
page integer no Page number for pagination (1-based, default: 1).
status string no Filter by customer status (e.g., "active", "inactive", "cancelled", "archive").

chargeover.chargeover_get_customer

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

Operation
Read read
Schema command
kosmo integrations:schema chargeover.chargeover_get_customer --json
ParameterTypeRequiredDescription
id integer yes The customer ID.

chargeover.chargeover_list_subscriptions

List subscriptions from ChargeOver. Returns subscription details including plan, billing cycle, status, and associated customer. Supports filtering by customer.

Operation
Read read
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).
page integer no Page number for pagination (1-based, default: 1).
customer_id integer no Filter subscriptions by customer ID.

chargeover.chargeover_list_invoices

List invoices from ChargeOver. Returns invoice details including amounts, dates, line items, and payment status. Supports pagination and status filtering.

Operation
Read read
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).
page integer no Page number for pagination (1-based, default: 1).
status string no Filter by invoice status (e.g., "open", "paid", "overdue", "cancelled").

chargeover.chargeover_get_invoice

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

Operation
Read read
Schema command
kosmo integrations:schema chargeover.chargeover_get_invoice --json
ParameterTypeRequiredDescription
id integer yes The invoice ID.

chargeover.chargeover_list_transactions

List transactions (payments) from ChargeOver. Returns payment records including amounts, methods, dates, and associated customers and invoices.

Operation
Read read
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).
page integer no Page number for pagination (1-based, default: 1).

chargeover.chargeover_get_current_user

Get information about the currently authenticated ChargeOver user and account. Useful for verifying connectivity and understanding which account the integration is connected to.

Operation
Read read
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.