Get concise developer guidance on available Billforward MCP tools and entities. Use this if you are unsure which tool to use.

Validate API credentials and get information about the authenticated user/organization.

List merchant accounts with support for pagination, sorting, and metadata filtering. Available fields include id, crmID, userID, created, updated, and an embedded profile (email, names, address). Use metadata filtering via 'meta.key=value'.

Find an account specifically by their email address. This is the fastest way to find a customer if you have their email.

Get detailed information about a specific account by ID. Contains billing contact info and linked metadata.

List all account profiles. Profiles contain contact details like firstName, lastName, email, and address fields.

Create a new account in Billforward. This is the first step for new customers.

Update an existing account profile. Billforward uses PUT for updates, so pass all relevant profile fields.

List all subscriptions with pagination and sorting. Use this to monitor customer subscription states (Active/Cancelled) and upcoming renewals. Note: Billforward has no native filter on subscription creation date — period_start_after/period_start_before filter by the current billing period start instead.

Get detailed state for a specific subscription by its unique ID. Includes current period start/end and pricing component states.

Create a new subscription for an account to a specific product rate plan.

Cancel an active subscription. By default, cancels at the end of the current billing period.

List all invoices with pagination and sorting. Invoices represent a request for payment for a period of service. Note: Billforward has no native filter on invoice creation date — period_start_after/period_start_before filter by the invoice's billing period start instead.

Get full details for a specific invoice. Includes line items, taxes, and payment status.

List payments across all accounts with pagination and sorting. Payments are records of money received into the system. Note: Billforward has no native created-date filter on this endpoint — when created_after/created_before are set, results are fetched sorted by created (regardless of orderBy) and filtered client-side.

Get full details for a specific payment by ID. Includes the offline payment justification (the 'description' field) when the payment was recorded manually rather than through a gateway.

List receipts across all accounts. Receipts usually map 1-to-1 with successful payments and provide audit data. Note: Billforward has no native created-date filter on this endpoint — when created_after/created_before are set, results are fetched sorted by created (regardless of orderBy) and filtered client-side.

List all products in the catalog. Products are the highest level of the billing hierarchy.

List all product rate plans. Rate plans define the pricing and logic for a product subscription.

Get detailed information about a specific product rate plan by ID or Data Name. This will return the full structure including pricing components and pricing tiers, essential for understanding how the plan is billed.

Perform a lightweight unified search across Accounts, Subscriptions, and Invoices. Automatically detects emails, IDs, or falls back to metadata/name filtering.

Provides a 360-degree view of a customer. Combines account details, active subscriptions, credit balances, and recent invoice history into one compact dashboard. Use this for quick context before troubleshooting or churn analysis.

Analyzes recently used metadata keys across Accounts and Subscriptions to provide a 'cheat sheet' of available custom fields (e.g., salesforce_account_id, duns). Use this to discover how to filter using the 'metadata' parameter.