ChargeOver MCP by usefulapi is an MCP server published by io.usefulapi, hosted at chargeover.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 25 tools, including chargeover_list_customers, chargeover_list_contacts, chargeover_list_invoices, chargeover_list_transactions, chargeover_list_quotes.
Read ChargeOver customers, invoices, transactions, subscriptions, reports; create customers, quotes.
4,221 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
List customers (companies that are billed). Filterable fields: customer_id, parent_customer_id, bill_state, ship_state, bill_country, ship_country, external_key, token, company, superuser_id, superuser_email, customer_status_state (a = active, i = inactive), customer_status_str (active-current, active-overdue, inactive-manual, inactive-activity), custom_1..custom_50, write_datetime, mod_datetime. Paged: pass next_offset as offset. GET /customer.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
{
"name": "chargeover_list_customers",
"title": "List or search customers",
"description": "List customers (companies that are billed). Filterable fields: customer_id, parent_customer_id, bill_state, ship_state, bill_country, ship_country, external_key, token, company, superuser_id, superuser_email, customer_status_state (a = active, i = inactive), customer_status_str (active-current, active-overdue, inactive-manual, inactive-activity), custom_1..custom_50, write_datetime, mod_datetime. Paged: pass next_offset as offset. GET /customer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
}
}
},
"annotations": {
"title": "List or search customers",
"readOnlyHint": true
}
}List contacts (the people at customers; the API calls them users). Filterable fields: user_id, external_key, first_name, last_name, email, phone, user_type_id, username, customers.customer_id (contacts of one customer). Paged: pass next_offset as offset. GET /user.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
{
"name": "chargeover_list_contacts",
"title": "List or search contacts",
"description": "List contacts (the people at customers; the API calls them users). Filterable fields: user_id, external_key, first_name, last_name, email, phone, user_type_id, username, customers.customer_id (contacts of one customer). Paged: pass next_offset as offset. GET /user.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
}
}
},
"annotations": {
"title": "List or search contacts",
"readOnlyHint": true
}
}List invoices with status, totals, credits, payments and balance. Filterable fields: invoice_id, refnumber, customer_id, invoice_status_str (open-unpaid, open-overdue, open-collections, closed-void, closed-paid), invoice_status_state (o = open, c = closed), package_id, package_token, date, currency_id, total, balance, subtotal, token, bill_state, bill_country, line_items.item_id, write_datetime, mod_datetime. Paged: pass next_offset as offset. GET /invoice.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
| include_line_items | boolean | true = include each record's line items (bigger reply). Default false. |
{
"name": "chargeover_list_invoices",
"title": "List or search invoices",
"description": "List invoices with status, totals, credits, payments and balance. Filterable fields: invoice_id, refnumber, customer_id, invoice_status_str (open-unpaid, open-overdue, open-collections, closed-void, closed-paid), invoice_status_state (o = open, c = closed), package_id, package_token, date, currency_id, total, balance, subtotal, token, bill_state, bill_country, line_items.item_id, write_datetime, mod_datetime. Paged: pass next_offset as offset. GET /invoice.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
},
"include_line_items": {
"type": "boolean",
"description": "true = include each record's line items (bigger reply). Default false."
}
}
},
"annotations": {
"title": "List or search invoices",
"readOnlyHint": true
}
}List transactions (payments, refunds and credits that already happened; this tool only reads them). Filterable fields: transaction_id, customer_id, gateway_id, currency_id, creditcard_id, ach_id, tokenized_id, token, external_key, gateway_status, gateway_transid, amount, fee, transaction_type, transaction_method, transaction_detail, transaction_datetime, transaction_status.state, transaction_status.str, applied_to.invoice_id, applied_to.package_id. Paged: pass next_offset as offset. GET /transaction.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
| include_applied_to | boolean | true = include the invoices each transaction was applied to (bigger reply). Default false. |
{
"name": "chargeover_list_transactions",
"title": "List or search transactions (read only)",
"description": "List transactions (payments, refunds and credits that already happened; this tool only reads them). Filterable fields: transaction_id, customer_id, gateway_id, currency_id, creditcard_id, ach_id, tokenized_id, token, external_key, gateway_status, gateway_transid, amount, fee, transaction_type, transaction_method, transaction_detail, transaction_datetime, transaction_status.state, transaction_status.str, applied_to.invoice_id, applied_to.package_id. Paged: pass next_offset as offset. GET /transaction.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
},
"include_applied_to": {
"type": "boolean",
"description": "true = include the invoices each transaction was applied to (bigger reply). Default false."
}
}
},
"annotations": {
"title": "List or search transactions (read only)",
"readOnlyHint": true
}
}List quotes (proposals for a customer or lead; the list has no line items, get one quote for those). Filterable fields: quote_id, customer_id, brand_id, currency_id, refnumber, token, external_key, date, bill_state, bill_country, quote_status_str (open-new, open-sent, closed-won, closed-lost), quote_status_state (o = open, c = closed). Paged: pass next_offset as offset. GET /quote.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
{
"name": "chargeover_list_quotes",
"title": "List or search quotes",
"description": "List quotes (proposals for a customer or lead; the list has no line items, get one quote for those). Filterable fields: quote_id, customer_id, brand_id, currency_id, refnumber, token, external_key, date, bill_state, bill_country, quote_status_str (open-new, open-sent, closed-won, closed-lost), quote_status_state (o = open, c = closed). Paged: pass next_offset as offset. GET /quote.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
}
}
},
"annotations": {
"title": "List or search quotes",
"readOnlyHint": true
}
}List subscriptions (the API calls them packages): recurring billing plans of customers. Filterable fields: package_id, customer_id, token, brand_id, paymethod, paycycle (mon, qtr, yrl...), nickname, package_status_state (a active, c cancelled, e expired, s suspended), package_status_str (active-trial, active-current, active-overdue, canceled-nonpayment, canceled-manual, expired-expired, expired-trial, suspended-suspended), external_key, write_datetime, mod_datetime, cancel_datetime, line_items.item_id, customer.superuser_email, customer.users.email. Paged: pass next_offset as offset. GET /package.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
| include_line_items | boolean | true = include each record's line items (bigger reply). Default false. |
{
"name": "chargeover_list_subscriptions",
"title": "List or search subscriptions",
"description": "List subscriptions (the API calls them packages): recurring billing plans of customers. Filterable fields: package_id, customer_id, token, brand_id, paymethod, paycycle (mon, qtr, yrl...), nickname, package_status_state (a active, c cancelled, e expired, s suspended), package_status_str (active-trial, active-current, active-overdue, canceled-nonpayment, canceled-manual, expired-expired, expired-trial, suspended-suspended), external_key, write_datetime, mod_datetime, cancel_datetime, line_items.item_id, customer.superuser_email, customer.users.email. Paged: pass next_offset as offset. GET /package.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
},
"include_line_items": {
"type": "boolean",
"description": "true = include each record's line items (bigger reply). Default false."
}
}
},
"annotations": {
"title": "List or search subscriptions",
"readOnlyHint": true
}
}List items: the products, services and discounts that go on invoices, quotes and subscriptions, with their pricing tiers. Filterable fields: item_id, name, external_key, accounting_sku, item_type (service or discount), custom_1, custom_2, custom_3. Paged: pass next_offset as offset. GET /item.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
{
"name": "chargeover_list_items",
"title": "List or search items (products and discounts)",
"description": "List items: the products, services and discounts that go on invoices, quotes and subscriptions, with their pricing tiers. Filterable fields: item_id, name, external_key, accounting_sku, item_type (service or discount), custom_1, custom_2, custom_3. Paged: pass next_offset as offset. GET /item.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
}
}
},
"annotations": {
"title": "List or search items (products and discounts)",
"readOnlyHint": true
}
}List notes attached to customers, subscriptions, invoices, contacts, quotes and items. Filterable fields: context_str (customer, billing_package, invoice, user, quote, item), context_id. Paged: pass next_offset as offset. GET /note.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
{
"name": "chargeover_list_notes",
"title": "List notes",
"description": "List notes attached to customers, subscriptions, invoices, contacts, quotes and items. Filterable fields: context_str (customer, billing_package, invoice, user, quote, item), context_id. Paged: pass next_offset as offset. GET /note.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
}
}
},
"annotations": {
"title": "List notes",
"readOnlyHint": true
}
}List usage (metered billing) data points recorded against subscription line items. Filterable fields: line_item_id, external_key, from (date), to (date). Paged: pass next_offset as offset. GET /usage.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
{
"name": "chargeover_list_usage",
"title": "List usage (metered) data",
"description": "List usage (metered billing) data points recorded against subscription line items. Filterable fields: line_item_id, external_key, from (date), to (date). Paged: pass next_offset as offset. GET /usage.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
}
}
},
"annotations": {
"title": "List usage (metered) data",
"readOnlyHint": true
}
}List coupons (code, description, type, enabled, linked discount item). Filterable fields: none documented; the list is small. Paged: pass next_offset as offset. GET /coupon.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-500 (default 50). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| filters | array | Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]. |
{
"name": "chargeover_list_coupons",
"title": "List coupons",
"description": "List coupons (code, description, type, enabled, linked discount item). Filterable fields: none documented; the list is small. Paged: pass next_offset as offset. GET /coupon.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Records per page, 1-500 (default 50)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"IS:NULL",
"ISNOT:NULL"
],
"type": "string",
"description": "EQUALS, NOTEQUALS, GT, GTE, LT, LTE, CONTAINS (substring), IS:NULL or ISNOT:NULL (no value)."
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$",
"description": "Filter field (the list tool's description names the valid ones)."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The value to compare with; omit for IS:NULL / ISNOT:NULL."
}
}
},
"maxItems": 10,
"description": "Filters, all combined with AND. Example: [{field:'customer_id',op:'EQUALS',value:12},{field:'date',op:'GTE',value:'2026-01-01'}]."
}
}
},
"annotations": {
"title": "List coupons",
"readOnlyHint": true
}
}Get one customer by customer_id: company, status, addresses, primary contact, terms, balance fields, custom fields. GET /customer/{customer_id}.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | The customer_id (a number). |
{
"name": "chargeover_get_customer",
"title": "Get a customer",
"description": "Get one customer by customer_id: company, status, addresses, primary contact, terms, balance fields, custom fields. GET /customer/{customer_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The customer_id (a number).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a customer",
"readOnlyHint": true
}
}Get one contact (user) by user_id: name, email, phone, username, the customers they belong to. GET /user/{user_id}.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | The user_id (a number). |
{
"name": "chargeover_get_contact",
"title": "Get a contact",
"description": "Get one contact (user) by user_id: name, email, phone, username, the customers they belong to. GET /user/{user_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The user_id (a number).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a contact",
"readOnlyHint": true
}
}Get one invoice by invoice_id: status, line items, totals, balance, payments and credits applied, billing address. GET /invoice/{invoice_id}.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | The invoice_id (a number). |
{
"name": "chargeover_get_invoice",
"title": "Get an invoice",
"description": "Get one invoice by invoice_id: status, line items, totals, balance, payments and credits applied, billing address. GET /invoice/{invoice_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The invoice_id (a number).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get an invoice",
"readOnlyHint": true
}
}Get one transaction (payment, refund or credit that already happened) by transaction_id: amount, method, status, the invoices it was applied to, related refunds. GET /transaction/{transaction_id}.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | The transaction_id (a number). |
{
"name": "chargeover_get_transaction",
"title": "Get a transaction (read only)",
"description": "Get one transaction (payment, refund or credit that already happened) by transaction_id: amount, method, status, the invoices it was applied to, related refunds. GET /transaction/{transaction_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The transaction_id (a number).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a transaction (read only)",
"readOnlyHint": true
}
}Get one quote by quote_id: status, line items, totals, memo, links to the invoice or subscription it became. GET /quote/{quote_id}.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | The quote_id (a number). |
{
"name": "chargeover_get_quote",
"title": "Get a quote",
"description": "Get one quote by quote_id: status, line items, totals, memo, links to the invoice or subscription it became. GET /quote/{quote_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The quote_id (a number).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a quote",
"readOnlyHint": true
}
}Get one subscription (package) by package_id: status, payment cycle, pay method, next invoice date, line items. GET /package/{package_id}.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | The package_id (a number). |
{
"name": "chargeover_get_subscription",
"title": "Get a subscription",
"description": "Get one subscription (package) by package_id: status, payment cycle, pay method, next invoice date, line items. GET /package/{package_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The package_id (a number).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a subscription",
"readOnlyHint": true
}
}Get one item (product, service or discount) by item_id: name, type, SKU, pricing tiers per currency. GET /item/{item_id}.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | The item_id (a number). |
{
"name": "chargeover_get_item",
"title": "Get an item",
"description": "Get one item (product, service or discount) by item_id: name, type, SKU, pricing tiers per currency. GET /item/{item_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The item_id (a number).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get an item",
"readOnlyHint": true
}
}List the account's saved reports (report_id and name). Run one with chargeover_run_report. GET /_report.
No parameters.
{
"name": "chargeover_list_reports",
"title": "List reports",
"description": "List the account's saved reports (report_id and name). Run one with chargeover_run_report. GET /_report.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List reports",
"readOnlyHint": true
}
}A report's name, its available_filters (field names and allowed operators), available_columns and default_columns. Read this before chargeover_run_report to know which filters and columns to use. GET /_report/{report_id}.
| Parameter | Type | Description |
|---|---|---|
| report_id * | integer | The report_id from chargeover_list_reports. |
{
"name": "chargeover_get_report",
"title": "Get a report's definition",
"description": "A report's name, its available_filters (field names and allowed operators), available_columns and default_columns. Read this before chargeover_run_report to know which filters and columns to use. GET /_report/{report_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"report_id"
],
"properties": {
"report_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The report_id from chargeover_list_reports.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a report's definition",
"readOnlyHint": true
}
}Run a saved report and return its rows (read only; nothing is changed). Filters use the report's own field names from chargeover_get_report, for example [{field:'transaction_transaction_date',op:'GTE',value:'2026-01-01'}]. Operators vary by field (dates GTE/LTE/EQUALS, ids EQUALS, strings CONTAINS/DOES_NOT_CONTAIN). To page (offset > 0) an order is required. Max 1000 rows per page. POST /_report/{report_id}/_action/reportData.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Rows per page, 1-1000 (default 100). |
| order | string | Sort as field:ASC or field:DESC, for example invoice_id:DESC. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| columns | array | Column names to return (default: the report's default columns). |
| filters | array | Report filters (combined with AND). |
| report_id * | integer | The report_id from chargeover_list_reports. |
{
"name": "chargeover_run_report",
"title": "Run a report",
"description": "Run a saved report and return its rows (read only; nothing is changed). Filters use the report's own field names from chargeover_get_report, for example [{field:'transaction_transaction_date',op:'GTE',value:'2026-01-01'}]. Operators vary by field (dates GTE/LTE/EQUALS, ids EQUALS, strings CONTAINS/DOES_NOT_CONTAIN). To page (offset > 0) an order is required. Max 1000 rows per page. POST /_report/{report_id}/_action/reportData.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"report_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Rows per page, 1-1000 (default 100)."
},
"order": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}:(ASC|DESC)$",
"description": "Sort as field:ASC or field:DESC, for example invoice_id:DESC."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"columns": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$"
},
"maxItems": 60,
"description": "Column names to return (default: the report's default columns)."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"EQUALS",
"NOTEQUALS",
"GT",
"GTE",
"LT",
"LTE",
"CONTAINS",
"DOES_NOT_CONTAIN"
],
"type": "string"
},
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,63}$"
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
},
"maxItems": 10,
"description": "Report filters (combined with AND)."
},
"report_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The report_id from chargeover_list_reports.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Run a report",
"readOnlyHint": true
}
}WRITE: create a new customer (no charge, no invoice, no email is sent by this call). Returns the new customer_id. Add a primary contact with the superuser_* fields. Use chargeover_list_customers first to avoid a duplicate (external_key is unique). POST /customer.
| Parameter | Type | Description |
|---|---|---|
| company * | string | Company / customer name. |
| bill_city | string | Billing city. |
| ship_city | string | Shipping city. |
| bill_addr1 | string | Billing address line 1. |
| bill_addr2 | string | Billing address line 2. |
| bill_state | string | Billing state/province. |
| ship_addr1 | string | Shipping address line 1. |
| ship_addr2 | string | Shipping address line 2. |
| ship_state | string | Shipping state/province. |
| bill_country | string | Billing country. |
| external_key |
WRITE: change fields of an existing customer; send only the fields to change. Cannot touch payment methods, balances or status. Replaces the previous values of the fields you send. PUT /customer/{customer_id}.
| Parameter | Type | Description |
|---|---|---|
| company | string | New company / customer name. |
| bill_city | string | Billing city. |
| ship_city | string | Shipping city. |
| bill_addr1 | string | Billing address line 1. |
| bill_addr2 | string | Billing address line 2. |
| bill_state | string | Billing state/province. |
| ship_addr1 | string | Shipping address line 1. |
| ship_addr2 | string | Shipping address line 2. |
| ship_state | string | Shipping state/province. |
| customer_id * | integer | The customer_id to update. |
| bill_country |
WRITE: add a contact (person) to an existing customer. No email is sent by this call. Returns the new user_id. POST /user.
| Parameter | Type | Description |
|---|---|---|
| name | string | Full name (alternative to first_name and last_name). |
| string | Email address. | |
| phone | string | Phone number. |
| title | string | Job title. |
| mobile | string | Mobile number. |
| last_name | string | Last name. |
| first_name | string | First name. |
| customer_id * | integer | The customer the contact belongs to. |
| external_key | string | Your own unique id for the contact. |
{
"name": "chargeover_create_contact",
"title": "Add a contact to a customer",
"description": "WRITE: add a contact (person) to an existing customer. No email is sent by this call. Returns the new user_id. POST /user.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"description": "Full name (alternative to first_name and last_name)."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "Email address."
},
"phone": {
"type": "string",
"maxLength": 50,
"description": "Phone number."
},
"title": {
"type": "string",
"maxLength": 100,
"description": "Job title."
},
"mobile": {
"type": "string",
"maxLength": 50,
"description": "Mobile number."
},
"last_name": {
"type": "string",
"maxLength": 100,
"description": "Last name."
},
"first_name": {
"type": "string",
"maxLength": 100,
"description": "First name."
},
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The customer the contact belongs to.",
"exclusiveMinimum": 0
},
"external_key": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Your own unique id for the contact."
}
}
},
"annotations": {
"title": "Add a contact to a customer",
"readOnlyHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: add a note to a customer, subscription, invoice, contact, quote or item (shown in the ChargeOver UI to the team; never sent to the customer). Returns the note id. POST /note.
| Parameter | Type | Description |
|---|---|---|
| note * | string | The note text. |
| context_id * | integer | The id of that record (customer_id, package_id, invoice_id, user_id, quote_id or item_id). |
| context_str * | string | What the note is attached to (billing_package = a subscription, user = a contact). |
{
"name": "chargeover_create_note",
"title": "Add a note",
"description": "WRITE: add a note to a customer, subscription, invoice, contact, quote or item (shown in the ChargeOver UI to the team; never sent to the customer). Returns the note id. POST /note.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"context_str",
"context_id",
"note"
],
"properties": {
"note": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "The note text."
},
"context_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The id of that record (customer_id, package_id, invoice_id, user_id, quote_id or item_id).",
"exclusiveMinimum": 0
},
"context_str": {
"enum": [
"customer",
"billing_package",
"invoice",
"user",
"quote",
"item"
],
"type": "string",
"description": "What the note is attached to (billing_package = a subscription, user = a contact)."
}
}
},
"annotations": {
"title": "Add a note",
"readOnlyHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: create a quote (a proposal) for an existing customer. Nothing is billed and no email is sent: the quote stays open until someone sends or accepts it in ChargeOver. Each line refers to an existing item (chargeover_list_items). paycycle: one = one-time invoice, mon = monthly, 2mn = every 2 months, qtr = quarterly, six = every 6 months, yrl = yearly, 2yr, 3yr, 1wk = weekly, 2wk. Returns the new quote_id. POST /quote.
| Parameter | Type | Description |
|---|---|---|
| date | string | A date as YYYY-MM-DD. |
| memo | string | Memo shown to the customer on the quote. |
| nickname | string | Nickname of the quote. |
| paycycle * | string | Billing cycle of the quote. |
| refnumber | string | Your reference number for the quote. |
| line_items * | array | At least one line. |
| customer_id * | integer | The customer the quote is for. |
| external_key | string | Your own unique id for the quote. |
| validuntil_date | string | Quote valid until, YYYY-MM-DD. |
Tools for ChargeOver, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which invoices are unpaid right now and what is the total balance?"; "List the active subscriptions for customer Acme Ltd."; "Show payments and refunds we processed last month.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes ChargeOver data. Free plan: 50 tool calls per month. Run chargeover_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run chargeover_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run chargeover_upgrade without a plan: it returns both plans, each with a payment link for the user to open. chargeover_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| string |
| Your own unique id for the customer (cannot be reused by default, even after deletion). |
| ship_country | string | Shipping country. |
| bill_postcode | string | Billing postal code. |
| ship_postcode | string | Shipping postal code. |
| superuser_email | string | Primary contact email address. |
| superuser_phone | string | Primary contact phone number. |
| parent_customer_id | integer | Parent customer id, to create a child customer. |
| superuser_last_name | string | Primary contact last name. |
| superuser_first_name | string | Primary contact first name. |
{
"name": "chargeover_create_customer",
"title": "Create a customer",
"description": "WRITE: create a new customer (no charge, no invoice, no email is sent by this call). Returns the new customer_id. Add a primary contact with the superuser_* fields. Use chargeover_list_customers first to avoid a duplicate (external_key is unique). POST /customer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Company / customer name."
},
"bill_city": {
"type": "string",
"maxLength": 100,
"description": "Billing city."
},
"ship_city": {
"type": "string",
"maxLength": 100,
"description": "Shipping city."
},
"bill_addr1": {
"type": "string",
"maxLength": 255,
"description": "Billing address line 1."
},
"bill_addr2": {
"type": "string",
"maxLength": 255,
"description": "Billing address line 2."
},
"bill_state": {
"type": "string",
"maxLength": 100,
"description": "Billing state/province."
},
"ship_addr1": {
"type": "string",
"maxLength": 255,
"description": "Shipping address line 1."
},
"ship_addr2": {
"type": "string",
"maxLength": 255,
"description": "Shipping address line 2."
},
"ship_state": {
"type": "string",
"maxLength": 100,
"description": "Shipping state/province."
},
"bill_country": {
"type": "string",
"maxLength": 100,
"description": "Billing country."
},
"external_key": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Your own unique id for the customer (cannot be reused by default, even after deletion)."
},
"ship_country": {
"type": "string",
"maxLength": 100,
"description": "Shipping country."
},
"bill_postcode": {
"type": "string",
"maxLength": 30,
"description": "Billing postal code."
},
"ship_postcode": {
"type": "string",
"maxLength": 30,
"description": "Shipping postal code."
},
"superuser_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "Primary contact email address."
},
"superuser_phone": {
"type": "string",
"maxLength": 50,
"description": "Primary contact phone number."
},
"parent_customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Parent customer id, to create a child customer.",
"exclusiveMinimum": 0
},
"superuser_last_name": {
"type": "string",
"maxLength": 100,
"description": "Primary contact last name."
},
"superuser_first_name": {
"type": "string",
"maxLength": 100,
"description": "Primary contact first name."
}
}
},
"annotations": {
"title": "Create a customer",
"readOnlyHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}| string |
| Billing country. |
| external_key | string | Your own unique id for the customer (cannot be reused by default, even after deletion). |
| ship_country | string | Shipping country. |
| bill_postcode | string | Billing postal code. |
| ship_postcode | string | Shipping postal code. |
| superuser_email | string | Primary contact email address. |
| superuser_phone | string | Primary contact phone number. |
| superuser_last_name | string | Primary contact last name. |
| superuser_first_name | string | Primary contact first name. |
{
"name": "chargeover_update_customer",
"title": "Update a customer",
"description": "WRITE: change fields of an existing customer; send only the fields to change. Cannot touch payment methods, balances or status. Replaces the previous values of the fields you send. PUT /customer/{customer_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"company": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "New company / customer name."
},
"bill_city": {
"type": "string",
"maxLength": 100,
"description": "Billing city."
},
"ship_city": {
"type": "string",
"maxLength": 100,
"description": "Shipping city."
},
"bill_addr1": {
"type": "string",
"maxLength": 255,
"description": "Billing address line 1."
},
"bill_addr2": {
"type": "string",
"maxLength": 255,
"description": "Billing address line 2."
},
"bill_state": {
"type": "string",
"maxLength": 100,
"description": "Billing state/province."
},
"ship_addr1": {
"type": "string",
"maxLength": 255,
"description": "Shipping address line 1."
},
"ship_addr2": {
"type": "string",
"maxLength": 255,
"description": "Shipping address line 2."
},
"ship_state": {
"type": "string",
"maxLength": 100,
"description": "Shipping state/province."
},
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The customer_id to update.",
"exclusiveMinimum": 0
},
"bill_country": {
"type": "string",
"maxLength": 100,
"description": "Billing country."
},
"external_key": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Your own unique id for the customer (cannot be reused by default, even after deletion)."
},
"ship_country": {
"type": "string",
"maxLength": 100,
"description": "Shipping country."
},
"bill_postcode": {
"type": "string",
"maxLength": 30,
"description": "Billing postal code."
},
"ship_postcode": {
"type": "string",
"maxLength": 30,
"description": "Shipping postal code."
},
"superuser_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "Primary contact email address."
},
"superuser_phone": {
"type": "string",
"maxLength": 50,
"description": "Primary contact phone number."
},
"superuser_last_name": {
"type": "string",
"maxLength": 100,
"description": "Primary contact last name."
},
"superuser_first_name": {
"type": "string",
"maxLength": 100,
"description": "Primary contact first name."
}
}
},
"annotations": {
"title": "Update a customer",
"readOnlyHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}{
"name": "chargeover_create_quote",
"title": "Create a quote",
"description": "WRITE: create a quote (a proposal) for an existing customer. Nothing is billed and no email is sent: the quote stays open until someone sends or accepts it in ChargeOver. Each line refers to an existing item (chargeover_list_items). paycycle: one = one-time invoice, mon = monthly, 2mn = every 2 months, qtr = quarterly, six = every 6 months, yrl = yearly, 2yr, 3yr, 1wk = weekly, 2wk. Returns the new quote_id. POST /quote.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"paycycle",
"line_items"
],
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "A date as YYYY-MM-DD."
},
"memo": {
"type": "string",
"maxLength": 2000,
"description": "Memo shown to the customer on the quote."
},
"nickname": {
"type": "string",
"maxLength": 255,
"description": "Nickname of the quote."
},
"paycycle": {
"enum": [
"one",
"mon",
"2mn",
"qtr",
"six",
"yrl",
"2yr",
"3yr",
"1wk",
"2wk"
],
"type": "string",
"description": "Billing cycle of the quote."
},
"refnumber": {
"type": "string",
"maxLength": 100,
"description": "Your reference number for the quote."
},
"line_items": {
"type": "array",
"items": {
"type": "object",
"required": [
"item_id"
],
"properties": {
"descrip": {
"type": "string",
"maxLength": 1000,
"description": "Line description override."
},
"item_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "An existing item_id.",
"exclusiveMinimum": 0
},
"expire_recurs": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Number of invoices before the line expires."
},
"line_quantity": {
"type": "number",
"maximum": 1000000000,
"description": "Quantity (default 1).",
"exclusiveMinimum": 0
}
}
},
"maxItems": 100,
"minItems": 1,
"description": "At least one line."
},
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The customer the quote is for.",
"exclusiveMinimum": 0
},
"external_key": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Your own unique id for the quote."
},
"validuntil_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Quote valid until, YYYY-MM-DD."
}
}
},
"annotations": {
"title": "Create a quote",
"readOnlyHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}