Skip to main content
The Chargefy MCP server connects compatible assistants to your Chargefy environment. Once authorized, the agent can query data, find documentation and run low-risk operational changes under the same rules and the same public objects as the API.
MCP never widens the permissions of whoever connects. Organization, environment, read and write are bounded by the OAuth consent or by the API key and revalidated on every call.

​
What you can do

With a read connection, the agent can:
  • list and retrieve 16 resource types, such as customers, products, invoices, charges, subscriptions and events;
  • search customers, catalog items, payment links and invoices by text;
  • load several objects by ID in a single call;
  • search the Chargefy documentation;
  • draft an integration plan without executing any change.
With write access, it can also create and update customers, products, prices, discounts, discount codes and payment links.
Captures, confirmations, refunds, cancellations, money movement, secrets and administrative actions are not part of MCP. Use the public API and your own backend controls for those flows.

​
Before you connect

You need:
  • a Chargefy account and access to the organization you want to connect;
  • a client that supports remote MCP over Streamable HTTP;
  • MCP enabled for the environment you want, under Developers → Connections;
  • OAuth in the browser or an organization API key;
  • write access only if the agent needs to create or edit data.
The test environment is enabled by default. The live environment starts disabled until an administrator turns it on.

​
Connect with OAuth

OAuth is the recommended path for interactive use. The client opens Chargefy in the browser, you pick an organization and set the access level for test and/or live.
Add the remote server:
Open /mcp, select chargefy and choose Authenticate. After signing in, pick an organization and review the access for each environment.
1

Pick an organization

Every connection belongs to a single organization. To work in another one, create a new connection or revoke and connect again.
2

Review the environments

Test and live appear separately. Enabled environments start selected as read only.
3

Grant writes only when needed

Read and write is an explicit choice. Your user’s own capabilities still bound which resources can be changed.
4

Authorize

The client receives the OAuth credential and from then on sees only the tools and operations allowed for that connection.

​
Connect with an API key

Use an API key when an automation must stay pinned to one organization and one environment. The key prefix defines the environment: ch_test_ for test and ch_live_ for live.
MCP does not accept platform keys scoped as platform_admin. Use an organization API key scoped read, write or admin.

​
Codex

Keep the token in an environment variable and reference the variable name:

​
Claude Code with .mcp.json

Create .mcp.json at the project root without putting the real token in the file:
Each person sets CHARGEFY_MCP_TOKEN in their own environment. If the file is shared, Claude Code asks for approval before using the project server.
Prefer OAuth for assistants used by people. Reserve API keys for clients that need a fixed context or that do not offer OAuth.

​
Validate the connection

Ask the agent:
Use the Chargefy connection for reading only. Show the organization, the environments and the access level available. Then list up to 5 customers in the test environment. Do not change any data.
The expected flow is:
1

Read the context

get_chargefy_account_info shows the organization, the environments and the connection’s access.
2

Discover the operation

chargefy_api_search finds customers.list.
3

Execute the read

chargefy_api_read queries customers in the test scope.
A read-only connection exposes nine tools. When at least one enabled environment has write access, chargefy_api_create and chargefy_api_update show up as well.

​
If something does not work

Use exactly https://mcp.chargefy.io, at the host root, and confirm the client supports Streamable HTTP. stdio or SSE configurations do not connect to this endpoint.
Open the client’s MCP management screen and look for Authenticate or Login. On Codex, run codex mcp login chargefy; on Claude Code, use /mcp.
Confirm the key belongs to an organization, has not expired or been revoked and starts with ch_test_ or ch_live_. Platform keys are not accepted.
The installation finished correctly. Check the enabled environment, read or write access, the user’s capability and the operation grant. See Access and permissions.
If OAuth authorized both test and live, ask it to call get_chargefy_account_info and send livemode: false for test or livemode: true for live on the tools that reach data.

​
Keep going

Access and permissions

Understand organization, environments, read, write and revocation.

Tools and operations

Browse the 11 tools and the 61 available operations.

Usage examples

Follow practical flows for discovery, querying and safe writes.

Limits and security

See rate limits, auditing and actions outside the surface.