KosmoKrator

payments

ChargeOver Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the ChargeOver KosmoKrator integration.

7 functions 7 read 0 write Bearer token auth
Submit ChargeOver feedback View package source

Lua Namespace

Agents call this integration through app.integrations.chargeover.*. Use lua_read_doc("integrations.chargeover") inside KosmoKrator to discover the same reference at runtime.

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Integration: ChargeOver

ChargeOver tools provide access to customers, subscriptions, invoices, and transactions.

Available Tools

  • chargeover_list_customers — List customers with pagination and status filtering.
  • chargeover_get_customer — Get a specific customer by ID.
  • chargeover_list_subscriptions — List subscriptions, optionally filtered by customer.
  • chargeover_list_invoices — List invoices with pagination and status filtering.
  • chargeover_get_invoice — Get a specific invoice by ID.
  • chargeover_list_transactions — List transactions (payments) with pagination.
  • chargeover_get_current_user — Get the authenticated user / account info.

Configuration

Requires access_token and either subdomain (e.g. mycompany) or a custom url (e.g. https://billing.example.com).

Raw agent markdown 
# Integration: ChargeOver

ChargeOver tools provide access to customers, subscriptions, invoices, and transactions.

## Available Tools

- `chargeover_list_customers` — List customers with pagination and status filtering.
- `chargeover_get_customer` — Get a specific customer by ID.
- `chargeover_list_subscriptions` — List subscriptions, optionally filtered by customer.
- `chargeover_list_invoices` — List invoices with pagination and status filtering.
- `chargeover_get_invoice` — Get a specific invoice by ID.
- `chargeover_list_transactions` — List transactions (payments) with pagination.
- `chargeover_get_current_user` — Get the authenticated user / account info.

## Configuration

Requires `access_token` and either `subdomain` (e.g. `mycompany`) or a custom `url` (e.g. `https://billing.example.com`).

Metadata-Derived Lua Example

local result = app.integrations.chargeover.chargeover_list_customers({
  limit = 1,
  page = 1,
  status = "example_status"
})
print(result)

Functions

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
Full name
chargeover.chargeover_list_customers
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_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
Full name
chargeover.chargeover_get_customer
ParameterTypeRequiredDescription
id integer yes The customer ID.

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
Full name
chargeover.chargeover_list_subscriptions
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_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
Full name
chargeover.chargeover_list_invoices
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_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
Full name
chargeover.chargeover_get_invoice
ParameterTypeRequiredDescription
id integer yes The invoice ID.

chargeover_list_transactions

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

Operation
Read read
Full name
chargeover.chargeover_list_transactions
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_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
Full name
chargeover.chargeover_get_current_user
ParameterTypeRequiredDescription
No parameters.