List customers with optional query parameters for filtering and pagination. GET /customers. See https://apiguide.rebillia.com/ for the Public API.

Get a specific customer by ID. GET /customers/{customerId}. Optional include supports: addressbook, paymentmethod, lastInvoice, subscriptions, unpaidInvoices, externalCustomers.

Create a new customer. POST /customers. Required: firstName, lastName, email. Optional: businessName, locale, phoneNum, phoneExt, preferredCurrency, taxExempt.

Update an existing customer. PUT /customers/{customerId}. Required: customerId. Optional: firstName, lastName, email, businessName, locale, phoneNum, phoneExt, preferredCurrency, taxExempt, status (active|disabled|archived).

Delete a customer by ID. DELETE /customers/{customerId}. WARNING: Cascading delete may remove or orphan related data (addresses, payment methods, subscriptions, invoices, etc.). Use with caution.

List invoices for a customer. GET /customers/{customerId}/invoices. Supports pagination (pageNo, itemPerPage), include (e.g. detail, transactions), status (authorized|posted|canceled|partialPaid|paid|voided|refund|partialRefund), dateFrom, dateTo, and subscriptionId.

List unpaid invoices for a customer. GET /customers/{customerId}/invoices/unpaid. Supports pagination (pageNo, itemPerPage).

List subscriptions for a customer. GET /customers/{customerId}/subscriptions. Supports pagination and include (e.g. rateplan, rateplanCharge).

List activity logs for a customer. GET /customers/{customerId}/logs. Returns paginated log entries.

List all address book entries for a customer. GET /customers/{customerId}/addressbooks. Optional: pageNo, itemPerPage.

Get a single address book entry by ID. GET /customers/{customerId}/addressbooks/{addressId}.

Create an address book entry for a customer. POST /customers/{customerId}/addressbooks. Required: name, contactName, street1, city, state, zip, countryCode (ISO 3166-1 alpha-2), type (residential or commercial). Optional: street2, company, contactEmail, contactPhone.

Update an address book entry (partial update). PUT /customers/{customerId}/addressbooks/{addressId}. Only explicitly provided fields are modified; omitted fields are kept from the existing address record.

Delete an address book entry. DELETE /customers/{customerId}/addressbooks/{addressId}.

List all payment methods for a customer. GET /customers/{customerId}/paymentmethods. Optional: pageNo, itemPerPage.

Get a single payment method by ID. GET /customers/{customerId}/paymentmethods/{paymentMethodId}.

Create a payment method for a customer. Gateway-agnostic: required companyGatewayId, type (card or ach), paymentMethodNonce, billingAddress (countryCode, street1, city, state, zip). Obtain gateway client credential via get_client_token; use your payment integration to produce paymentMethodNonce, then call this tool. No raw card data or gateway-specific fields in MCP.

Update a payment method's billing address (gateway-agnostic). PUT /customers/{customerId}/paymentmethods/{paymentMethodId}. Required: customerId, paymentMethodId, billingAddress (countryCode, street1, city, state, zip). Optional: street2. No payment or gateway-specific fields.

Delete a payment method. DELETE /customers/{customerId}/paymentmethods/{paymentMethodId}.

List charges and credits for a customer. GET /customers/{customerId}/charges_credits. Optional filters: status, type (charge or credit).

Create a charge or credit for a customer. POST /customers/{customerId}/charges_credits. IMPORTANT: amount is in CENTS (e.g. 10000 = $100.00). Required: amount (integer, in cents), type (charge or credit), companyCurrencyId, category (physical or digital). Optional: description, qty (default 1), isFreeShipping, taxable, weight (required by API when category is physical).

Delete a charge or credit for a customer. DELETE /customers/{customerId}/charges_credits/{chargeCreditId}. Fails if the charge/credit has invoice details assigned.

List products. GET /products. Optional: include (productRateplan, productRateplanCharge, chargeTier), status (published|draft|archived|disabled), name, category (baseProducts|addOn|bundleProduct|miscellaneous|service), orderBy, sortBy (ASC/DESC), itemPerPage, pageNo.

Get a product by ID. GET /products/{productId}. Optional: include.

Create a product. POST /products. Required: name, category. Optional: description, internalProductId, sku.

Update a product. PUT /products/{productId}. Optional: name, category, description, internalProductId, sku.

Delete a product. DELETE /products/{productId}. Warning: This also deletes associated rate plans and related data (cascading deletion).

Update a product status. PUT /products/{productId}/status. Required: status. Valid values: published, archived, disabled.

Link an external product to a product. POST /products/{productId}/external-products. Required: companyIntegrationId, productId (external), settings with modifierDisplayName.

Unlink an external product from a product. DELETE /products/{productId}/external-products/{externalProductId}.

List product rate plans for a product. GET /products/{productId}/product-rateplans. Product reference: productId (URI: /products/{productId}). Optional: include, orderBy, sortBy, pageNo, itemPerPage.

Get a rate plan by ID. GET /product-rateplans/{ratePlanId}. Rate plan reference: ratePlanId (URI: /product-rateplans/{ratePlanId}).

Create a rate plan. POST /product-rateplans. Required: productId (product reference, URI: /products/{productId}), name, type (contract|ongoing|prepaid). Optional: description, effectiveStartDate, effectiveEndDate, minimumCommitment, image.

Update a rate plan. PUT /product-rateplans/{ratePlanId}. Optional: name, type (contract|ongoing|prepaid), description, effectiveStartDate, effectiveEndDate, image.

Delete a rate plan. DELETE /product-rateplans/{ratePlanId}.

Update a rate plan status. PUT /product-rateplans/{ratePlanId}/status. Required: status. Valid values: published, archived, disabled, discontinue.

Sync a rate plan. POST /product-rateplans/{ratePlanId}/sync.

List product rate plan charges for a product rate plan. GET /product-rateplans/{ratePlanId}/product-rateplan-charges. Product rate plan reference: ratePlanId (URI: /product-rateplans/{ratePlanId}). Optional: include, orderBy, sortBy, pageNo, itemPerPage.

Get a rate plan charge by ID. GET /product-rateplan-charges/{chargeId}.

Create a rate plan charge. POST /product-rateplan-charges. Required: ratePlanId (rate plan reference, URI: /product-rateplans/{ratePlanId}), name, chargeType (oneTime|recurring|usage), chargeModel (flatFeePricing|perUnitPricing|tieredPricing|volumePricing), billCycleType, category (physical|digital), chargeTier (array of {currency ex. 'USD', price in cents, optional startingUnit, endingUnit, priceFormat, tier}), taxable, weight. Optional: billingPeriod (day|week|month|year), billingTiming (inAdvance|inArrears), description, etc.

Update a product rate plan charge. PUT /product-rateplan-charges/{chargeId}. You can send only the fields you want to change (e.g. chargeTier with new price); the tool fetches the current charge and merges your input so the backend receives all required fields. Validates in MCP before calling the API. Optional inputs: name, chargeType, chargeModel, billCycleType, category, chargeTier (currency, price as dollars e.g. 22.87 or cents e.g. 2287), taxable, weight, endDateCondition, billingPeriod, billingTiming, billingPeriodAlignment, specificBillingPeriod, billCycleDay (1-31 when billCycleType specificDayOfMonth), weeklyBillCycleDay (when specificDayOfWeek), monthlyBillCycleYear (1-12 when specificMonthOfYear). When chargeType is recurring, billingPeriod, specificBillingPeriod, billingPeriodAlignment, billingTiming are required.

Delete a rate plan charge. DELETE /product-rateplan-charges/{chargeId}.

List subscriptions. GET /subscriptions. Optional: include, query, orderBy, sortBy, filterId, status (exact status), customerId (customer id), companyGatewayId (subscription company gateway id), dateFrom/dateTo (createdAt range; dateFrom from 00:00:00, dateTo through 23:59:59; invalid dates are ignored), itemPerPage, pageNo. Examples: /v1/subscriptions?status=active ; /v1/subscriptions?customerId=123&companyGatewayId=8 ; /v1/subscriptions?dateFrom=2026-01-01&dateTo=2026-01-31 ; /v1/subscriptions?status=paused&customerId=123&dateFrom=2026-01-01&dateTo=2026-01-31.

Get a subscription by ID. GET /subscriptions/{subscriptionId}. Optional: include.

Create a subscription from a product rate plan. POST /subscriptions/from-product-rateplan. Required: productRatePlanId, customerId, customerPaymentMethodId, billingAddressId, effectiveStartDate.

Update a subscription. PUT /subscriptions/{subscriptionId}. Optional: name, companyCurrencyId, companyGatewayId, customerPaymentMethodId, detail, effectiveStartDate, billingAddressId, shippingAddressId.

Delete a subscription. DELETE /subscriptions/{subscriptionId}. Warning: Prefer changing status to archived (update_subscription_status) instead of deleting when you want to end a subscription without removing it from records.

Update a subscription status. PUT /subscriptions/{subscriptionId}/status. Required: status. Meanings: active – subscription is active and billing; paused – subscription is temporarily paused (no billing); archived – subscription is ended/archived (use instead of delete when ending); requestPayment – subscription is awaiting payment method or payment.

View all upcoming charges for a subscription. GET /subscriptions/{subscriptionId}/upcoming. Returns scheduled charges (recurring, one-time, usage) with amounts and dates. Optional: include.

List invoices for a subscription. GET /subscriptions/{subscriptionId}/invoices. Returns paginated invoices. Use include for line-item detail and transactions (e.g. include=detail,transactions).

Get activity history for a subscription. GET /subscriptions/{subscriptionId}/logs. Returns paginated log entries (status changes, renewals, payments, etc.).

List e-commerce orders (external invoices) linked to a subscription. GET /subscriptions/{subscriptionId}/external-invoices. Returns paginated external invoice records. Optional: include, pageNo, itemPerPage.

List rate plans on a subscription. GET /subscriptions/{subscriptionId}/rateplans. Returns paginated rate plans (product rate plan ref, name, type, effectiveStartDate, charges when included). Optional: include, pageNo, itemPerPage, orderBy, sortBy, status (active|pause|cancel|archived), type (ongoing|prepaid|contract). status/type filters are case-insensitive.

Get a single rate plan on a subscription. GET /subscriptions/{subscriptionId}/rateplans/{ratePlanId}.

Add a rate plan to a subscription. POST /subscriptions/{subscriptionId}/rateplans. Required: productRatePlanId (product rate plan to attach). Optional: name, type (contract|ongoing|prepaid), effectiveStartDate, changeStatusBasedOnCharge, ratePlanCharge (array of {quantity, optional productRatePlanChargeId, or name, chargeType, chargeTier, etc.).

Update a rate plan on a subscription. PUT /subscriptions/{subscriptionId}/rateplans/{ratePlanId}. Optional: name, type (contract|ongoing|prepaid), effectiveStartDate, changeStatusBasedOnCharge.

Remove a rate plan from a subscription. DELETE /subscriptions/{subscriptionId}/rateplans/{ratePlanId}.

Get a single rate plan charge on a subscription. GET /subscriptions/{subscriptionId}/rateplan-charges/{chargeId}.

Add a rate plan charge to a subscription rate plan. POST .../rateplan-charges. Required: subscriptionId, ratePlanId, quantity, name, category (physical|digital), chargeModel (flatFeePricing|perUnitPricing|tieredPricing|volumePricing), billCycleType (chargeTriggerDay|defaultFromCustomer|specificDayOfMonth|specificDayOfWeek|specificMonthOfYear|subscriptionStartDay|subscriptionFreeTrial), chargeTier array (each: currency, price required; optional startingUnit, endingUnit, priceFormat, tier), chargeType (oneTime|recurring|usage), endDateCondition (subscriptionEnd|fixedPeriod), taxable (boolean), weight. When chargeType is recurring, billingPeriodAlignment and specificBillingPeriod are also required. Optional: productRatePlanChargeId, billingPeriod, billingTiming.

Update a rate plan charge on a subscription. PUT /subscriptions/{subscriptionId}/rateplan-charges/{chargeId}. Required: subscriptionId, chargeId, quantity, name, chargeModel (flatFeePricing|perUnitPricing|tieredPricing|volumePricing), billCycleType, chargeTier (array: currency, price required). For price, you can pass a string dollars '41.00' or integer cents 4100 – the tool always sends cents to the API (same logic as create_invoice detail.amount). Also required: chargeType (oneTime|recurring|usage), endDateCondition (subscriptionEnd|fixedPeriod), taxable (boolean), weight. When chargeType is recurring, billingPeriodAlignment is also required. Optional: billingPeriod, billingTiming, specificBillingPeriod.

Remove a rate plan charge from a subscription. DELETE /subscriptions/{subscriptionId}/rateplan-charges/{chargeId}.

List invoices. GET /invoices. Optional: include (detail, transactions, billruns, externalInvoices), status, query, orderBy, sortBy, filterId, itemPerPage, pageNo.

Get an invoice by ID. GET /invoices/{invoiceId}. Optional: include.

Create an invoice. POST /invoices. Required: companyCurrencyId, companyGatewayId, customerId, paymentMethodId, detail (array, at least one line item), dateDue, dateFrom, dateTo. Optional: billingAddress, shippingAddress (when provided: contactName, street1, city, zip, countryCode (ISO 3166-1 alpha-2), type residential|commercial), customerEmail (max 45), customerName (max 45), customerPhone (max 45), paymentType (offlinePaymentProvider|thirdPartyPaymentProvider|walletPaymentProvider|otherPayment), shippingAmount (CENTS), terms (max 200), comments (max 200). Detail: amount can be '41.00' (dollars) or 4100 (cents). Tool always sends cents to publicAPI.

Update an invoice. PUT /invoices/{invoiceId}. Only invoices with status 'posted' or 'requestPayment' can be updated. All body fields optional. Accepted: companyGatewayId, customerId, customerEmail, customerName, customerPhone (max 45), customerPaymentMethodId, dateDue, dateFrom, dateTo, comments, paymentType (offlinePaymentProvider|thirdPartyPaymentProvider|walletPaymentProvider), paymentMethodId, shippingAddress (when provided: contactName, street1, city, zip, countryCode (ISO 3166-1 alpha-2), type residential|commercial), shippingAmount (cents), shippingServiceId, detail (line items: amount as '41.00' dollars or 4100 cents; tool sends cents). Note: billingAddress is not accepted on update. Invoice must have customer and customerPaymentMethod set to avoid server error.

Delete an invoice. DELETE /invoices/{invoiceId}.

Charge an invoice (card/online payment). POST /invoices/{invoiceId}/charge. AMOUNT IN CENTS: e.g. 5500 = $55.00. Required: invoiceId, amount (integer cents), paymentType (offlinePaymentProvider | thirdPartyPaymentProvider | walletPaymentProvider | otherPayment). Use thirdPartyPaymentProvider for card/online.

Charge an invoice via offline payment (cash/check/wire). POST /invoices/{invoiceId}/charge with paymentType: offlinePaymentProvider. AMOUNT IN CENTS: e.g. 5500 = $55.00. Required: invoiceId, amount (integer cents).

Void an invoice. PUT /invoices/{invoiceId}/void. CRITICAL: This action is IRREVERSIBLE. Use with caution.

List transactions. GET /transactions. Optional: customerId, invoiceId, status (settled|authorized|declined|error|voided|requiresPaymentMethod|awaitingForSettlement|authorizeAndHold), type (sale|refund), dateFrom, dateTo, companyGatewayId, orderBy, sortBy, itemPerPage, pageNo.

Get a transaction by ID. GET /transactions/{transactionId}.

Refund a transaction. POST /transactions/{transactionId}/refund. AMOUNT IN CENTS: e.g. 250 = $2.50, 5500 = $55.00. Required: transactionId, amount (integer cents).

Void a transaction. POST /transactions/{transactionId}/void. Only works before settlement; after settlement use refund_transaction instead.

List bill runs. GET /bill-run. Optional: include (e.g. invoice), query (filter by status: completed, pending, error), orderBy, sortBy, itemPerPage, pageNo.

Get a bill run by ID. GET /bill-run/{billRunId}.

Update a bill run. PUT /bill-run/{billRunId}. Required: billRunId, newDateTime. Use ISO 8601: YYYY-MM-DDTHH:MM:SS or with timezone (e.g. 2026-02-26T20:05:00Z). If no timezone, Z (UTC) is appended. Note: this tool only works on bill runs with status pending. Calls against completed or error runs will fail.

Get invoices for a bill run. GET /bill-run/{billRunId}/invoices. Returns paginated invoices. Optional: pageNo, itemPerPage.

List available global gateway types (e.g. Stripe, Braintree). GET /globals/gateways. Returns gblGatewayId, name, keyName, requiredFields (setting keys), and fieldDetails (keyName + displayName). Use this before create_gateway to discover valid gblGatewayId and which keys to pass in the setting object.

List company gateways. GET /gateways. Optional: status (filter by active, disabled, error, archive), companyCurrencyId, include.

Get a company gateway by ID. GET /gateways/{gatewayId}.

Get the gateway client credential to initialize your payment integration and produce a paymentMethodNonce. Use the returned value in your hosted payment UI; then pass the resulting token as paymentMethodNonce to create_customer_payment_method. Gateway-agnostic: no gateway-specific concepts in MCP. Optional customerId scopes the credential to a customer (e.g. for vault). Required for PayFabric; optional for others. Requires company API token (X-AUTH-TOKEN).

Create or retrieve a setup intent via the gateway endpoint. Use only as part of a gateway-agnostic payment method flow: the returned setupIntent.id can be used as paymentMethodNonce for create_customer_payment_method. No raw card data.

Create a company gateway. POST /gateways. Required: gblGatewayId, setting (credentials object). Optional: displayName, card (array of card type IDs), paymentMethod. Use list_global_gateways first to discover valid gblGatewayId and required setting keys (requiredFields / fieldDetails) for each gateway type (e.g. Stripe, Braintree); then build setting with those keys as field names and your credential values.

Update a company gateway. PUT /gateways/{gatewayId}. Optional: displayName, setting (credentials key-value object).

Delete a company gateway. DELETE /gateways/{gatewayId}. Fails if gateway is linked to company currencies or customers.

Test gateway connection. GET /gateways/{gatewayId}/test. Returns the gateway object with connection status (e.g. status active on success).

List company currencies. GET /currencies. Optional: include, itemPerPage, pageNo.

Get a company currency by ID. GET /currencies/{currencyId}.

Create a company currency. POST /currencies. Required: currencyId (global currency ID), conversionRate (number), fixedRate (boolean).

Update a company currency. PUT /currencies/{companyCurrencyId}. Required: companyCurrencyId, conversionRate, fixedRate.

Delete a company currency. DELETE /currencies/{companyCurrencyId}. Fails if currency is in use (invoices, subscriptions, transactions, or gateways).

Get the company default currency. GET /currencies/default.

Set the company default currency. POST /currencies/default. Required: currencyId (global currency ID). Creates company currency if needed. Fails if there are invoices with that currency.

List company integrations. GET /integrations. Optional: type (ecommerce, email, marketing, tax, shipping, accounting, chat).

Get company integration config by ID. GET /integrations/{integrationId}/config.

Get global integration info by key name. GET /integrations/{keyName}/get. keyName: avalara, bigcommerce, customRate, fedex, flatRate, freeShipping, freshBooksCloudAccounting, google, mailchimp, monsoonStoneEdge, myob, pickupInStore, quickbooks, saasu, salesforce, shipBy, shipperHq, shippingZone, shopify, slack, smtp, taxamo, thomsonreuters, ups, upsShippingProtection, usps, vertex, xero.

List company integrations by key name. GET /integrations/{keyName}/list. keyName: avalara, bigcommerce, customRate, fedex, flatRate, freeShipping, freshBooksCloudAccounting, google, mailchimp, monsoonStoneEdge, myob, pickupInStore, quickbooks, saasu, salesforce, shipBy, shipperHq, shippingZone, shopify, slack, smtp, taxamo, thomsonreuters, ups, upsShippingProtection, usps, vertex, xero.

List external invoices for an integration. GET /integrations/{integrationId}/external-invoices. Optional: include, itemPerPage, pageNo.

List external products for an integration. GET /integrations/{integrationId}/products. Required: integrationId, productName (sent as name query param).

Get an external product by ID. GET /integrations/{integrationId}/products/{externalProductId}. API expects numeric productId.