{"openapi":"3.1.0","info":{"title":"Chargebee (BYOK) API","version":"0.1.0","description":"Chargebee (BYOK) lets an AI assistant read your own Chargebee data through the Chargebee API with a key you supply (Chargebee API key (a read-only key is enough)). Read-only: 7 tools (list_subscriptions, list_customers, list_invoices, list_transactions, list_item_prices, list_items, list_plans). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-chargebee.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-chargebee/docs"},"termsOfService":"https://connectorbay.com/byok-chargebee/terms"},"servers":[{"url":"https://byok-chargebee.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-chargebee/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_subscriptions":{"post":{"operationId":"list_subscriptions","summary":"List Chargebee subscriptions with status, customer, term dates, next billing time, monthly recurring revenue and amounts","description":"List Chargebee subscriptions with status, customer, term dates, next billing time, monthly recurring revenue and amounts due. Pass next_offset for the next page. Use for \"Which Chargebee subscriptions are active and when do they renew\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"status_is":{"anyOf":[{"enum":["future","in_trial","active","non_renewing","paused","cancelled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only subscriptions in this status.","title":"Status Is"},"customer_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only subscriptions of this customer ID.","title":"Customer Id Is"},"next_billing_before":{"anyOf":[{"maximum":4102444800,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only subscriptions billing before this Unix timestamp (seconds).","title":"Next Billing Before"},"sort_by_desc":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"default":null,"description":"Newest first by this timestamp: created_at or updated_at. Omit for the provider's default order.","title":"Sort By Desc"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100; provider default 10).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"},"include_deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include deleted records.","title":"Include Deleted"}},"required":["site"],"title":"list_subscriptionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_customers":{"post":{"operationId":"list_customers","summary":"List Chargebee customers with name, email, company, billing mode, balances and creation time. Pass next_offset for the n","description":"List Chargebee customers with name, email, company, billing mode, balances and creation time. Pass next_offset for the next page. Use for \"Find the Chargebee customer with email jo@example.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"email_is":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the customer with exactly this email address.","title":"Email Is"},"company_is":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only customers of exactly this company name.","title":"Company Is"},"first_name_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only customers with exactly this first name.","title":"First Name Is"},"last_name_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only customers with exactly this last name.","title":"Last Name Is"},"sort_by_desc":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"default":null,"description":"Newest first by this timestamp: created_at or updated_at. Omit for the provider's default order.","title":"Sort By Desc"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100; provider default 10).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"},"include_deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include deleted records.","title":"Include Deleted"}},"required":["site"],"title":"list_customersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_invoices":{"post":{"operationId":"list_invoices","summary":"List Chargebee invoices with number, customer, subscription, status, totals, amount due and dates. Amounts are in the sm","description":"List Chargebee invoices with number, customer, subscription, status, totals, amount due and dates. Amounts are in the smallest currency unit (cents). Pass next_offset for the next page. Use for \"Which Chargebee invoices are unpaid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"status_is":{"anyOf":[{"enum":["paid","posted","payment_due","not_paid","voided","pending"],"type":"string"},{"type":"null"}],"default":null,"description":"Only invoices in this status.","title":"Status Is"},"customer_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only invoices of this customer ID.","title":"Customer Id Is"},"subscription_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only invoices of this subscription ID.","title":"Subscription Id Is"},"date_after":{"anyOf":[{"maximum":4102444800,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only invoices dated after this Unix timestamp (seconds).","title":"Date After"},"sort_by_desc":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"default":null,"description":"Newest first by this timestamp: created_at or updated_at. Omit for the provider's default order.","title":"Sort By Desc"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100; provider default 10).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"},"include_deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include deleted records.","title":"Include Deleted"}},"required":["site"],"title":"list_invoicesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_transactions":{"post":{"operationId":"list_transactions","summary":"List Chargebee payment transactions (payments and refunds) with type, status, amount, gateway and date. Amounts are in t","description":"List Chargebee payment transactions (payments and refunds) with type, status, amount, gateway and date. Amounts are in the smallest currency unit. Pass next_offset for the next page. Use for \"What payments did Chargebee record recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"status_is":{"anyOf":[{"enum":["in_progress","success","voided","failure","timeout","needs_attention"],"type":"string"},{"type":"null"}],"default":null,"description":"Only transactions in this status.","title":"Status Is"},"type_is":{"anyOf":[{"enum":["authorization","payment","refund","payment_reversal"],"type":"string"},{"type":"null"}],"default":null,"description":"Only transactions of this type.","title":"Type Is"},"customer_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only transactions of this customer ID.","title":"Customer Id Is"},"date_after":{"anyOf":[{"maximum":4102444800,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only transactions dated after this Unix timestamp (seconds).","title":"Date After"},"sort_by_desc":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"default":null,"description":"Newest first by this timestamp: created_at or updated_at. Omit for the provider's default order.","title":"Sort By Desc"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100; provider default 10).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"},"include_deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include deleted records.","title":"Include Deleted"}},"required":["site"],"title":"list_transactionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_item_prices":{"post":{"operationId":"list_item_prices","summary":"List Chargebee item prices (what customers are charged: price, period, currency, trial) for sites on Product Catalog 2.0","description":"List Chargebee item prices (what customers are charged: price, period, currency, trial) for sites on Product Catalog 2.0. Prices are in the smallest currency unit. Use for \"What prices and billing periods are in my Chargebee catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"item_type_is":{"anyOf":[{"enum":["plan","addon","charge"],"type":"string"},{"type":"null"}],"default":null,"description":"Only prices of this item type.","title":"Item Type Is"},"status_is":{"anyOf":[{"enum":["active","archived","deleted"],"type":"string"},{"type":"null"}],"default":null,"description":"Only item prices in this status.","title":"Status Is"},"item_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only prices of this item ID.","title":"Item Id Is"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100; provider default 10).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"}},"required":["site"],"title":"list_item_pricesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_items":{"post":{"operationId":"list_items","summary":"List Chargebee items (plans, addons and charges) for sites on Product Catalog 2.0. Use for \"What plans and addons exist ","description":"List Chargebee items (plans, addons and charges) for sites on Product Catalog 2.0. Use for \"What plans and addons exist in my Chargebee catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"type_is":{"anyOf":[{"enum":["plan","addon","charge"],"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this type.","title":"Type Is"},"status_is":{"anyOf":[{"enum":["active","archived","deleted"],"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this status.","title":"Status Is"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100; provider default 10).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"}},"required":["site"],"title":"list_itemsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_plans":{"post":{"operationId":"list_plans","summary":"List Chargebee plans for sites still on Product Catalog 1.0 (newer sites use list_items and list_item_prices). Prices ar","description":"List Chargebee plans for sites still on Product Catalog 1.0 (newer sites use list_items and list_item_prices). Prices are in the smallest currency unit. Use for \"What plans do I have in Chargebee\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"status_is":{"anyOf":[{"enum":["active","archived","deleted"],"type":"string"},{"type":"null"}],"default":null,"description":"Only plans in this status.","title":"Status Is"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100; provider default 10).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"}},"required":["site"],"title":"list_plansArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}