{"openapi":"3.1.0","info":{"title":"Chargebee Pricing Config (BYOK) API","version":"0.1.0","description":"Chargebee Pricing Config (BYOK) lets an AI assistant read your own Chargebee Pricing Config data through the Chargebee Pricing Config API with a key you supply (Chargebee API key (a read-only key is enough)). Read-only: 9 tools (list_price_variants, list_differential_prices, list_attached_items, get_attached_item, list_currencies, list_custom_field_configs, list_payment_schedule_schemes,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-chargebee-pricing-config.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-chargebee-pricing-config/docs"},"termsOfService":"https://connectorbay.com/byok-chargebee-pricing-config/terms"},"servers":[{"url":"https://byok-chargebee-pricing-config.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-chargebee-pricing-config/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_price_variants":{"post":{"operationId":"list_price_variants","summary":"List Chargebee price variants (named variations of a price, for example by region or channel) with name, group, descript","description":"List Chargebee price variants (named variations of a price, for example by region or channel) with name, group, description and status. Product Catalog 2.0 sites only. Timestamps are Unix seconds. Use for \"Which price variants are defined 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 variants with this status.","title":"Status Is"},"name_starts_with":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only variants whose name starts with this text.","title":"Name Starts With"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","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_price_variantsArguments","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_differential_prices":{"post":{"operationId":"list_differential_prices","summary":"List differential prices (add-on or charge prices that differ depending on the plan they are bought with) with price, cu","description":"List differential prices (add-on or charge prices that differ depending on the plan they are bought with) with price, currency, tiers and status. Amounts are in the smallest currency unit. Timestamps are Unix seconds. Use for \"Which add-ons have plan-specific prices 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"},"item_price_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only differential prices of this add-on or charge item price id.","title":"Item Price Id Is"},"item_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only differential prices of this add-on or charge item id.","title":"Item Id Is"},"parent_item_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only differential prices tied to this plan item id.","title":"Parent Item Id Is"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","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_differential_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_attached_items":{"post":{"operationId":"list_attached_items","summary":"List the add-ons and charges attached to a Chargebee plan item (recommended, mandatory or optional) with quantity, billi","description":"List the add-ons and charges attached to a Chargebee plan item (recommended, mandatory or optional) with quantity, billing cycles and charge event. Timestamps are Unix seconds. Use for \"Which add-ons are attached to the Chargebee plan item pro-plan\".","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_id":{"description":"Plan item id, for example pro-plan.","maxLength":200,"title":"Item Id","type":"string"},"type_is":{"anyOf":[{"enum":["recommended","mandatory","optional"],"type":"string"},{"type":"null"}],"default":null,"description":"Only attached items of this kind.","title":"Type Is"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","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","item_id"],"title":"list_attached_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/get_attached_item":{"post":{"operationId":"get_attached_item","summary":"Get one attached item by id, with the id of the plan item it is attached to: kind, quantity, billing cycles and charge e","description":"Get one attached item by id, with the id of the plan item it is attached to: kind, quantity, billing cycles and charge event. Timestamps are Unix seconds. Use for \"What are the terms of attached item ai_1 on plan item pro-plan\".","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"},"attached_item_id":{"description":"Attached item id.","maxLength":200,"title":"Attached Item Id","type":"string"},"parent_item_id":{"description":"Id of the plan item the item is attached to.","maxLength":100,"title":"Parent Item Id","type":"string"}},"required":["site","attached_item_id","parent_item_id"],"title":"get_attached_itemArguments","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_currencies":{"post":{"operationId":"list_currencies","summary":"List the currencies enabled on the Chargebee site with code, forex type (manual or auto), base-currency flag and manual ","description":"List the currencies enabled on the Chargebee site with code, forex type (manual or auto), base-currency flag and manual exchange rate. Use for \"Which currencies is my Chargebee site set up for\".","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"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","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_currenciesArguments","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_custom_field_configs":{"post":{"operationId":"list_custom_field_configs","summary":"List custom field definitions (extra fields on customers, subscriptions, invoices and more) with entity type, API name, ","description":"List custom field definitions (extra fields on customers, subscriptions, invoices and more) with entity type, API name, label, data type, whether required and status. Field values are not returned. Use for \"Which custom fields have I defined 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"},"entity_type":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only custom fields of this entity type, for example customer, subscription, invoice or plan.","title":"Entity Type"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","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_custom_field_configsArguments","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_payment_schedule_schemes":{"post":{"operationId":"list_payment_schedule_schemes","summary":"List payment schedule schemes (how an invoice is split into instalments) with number of instalments, period unit and per","description":"List payment schedule schemes (how an invoice is split into instalments) with number of instalments, period unit and period. Use for \"Which instalment schemes exist 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"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","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_payment_schedule_schemesArguments","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_credit_units":{"post":{"operationId":"list_credit_units","summary":"List credit units (prepaid or usage credit currencies) with name, status, whether unlimited and overdraft amount. Use fo","description":"List credit units (prepaid or usage credit currencies) with name, status, whether unlimited and overdraft amount. Use for \"Which credit units has Chargebee defined\".","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"],"type":"string"},{"type":"null"}],"default":null,"description":"Only credit units with this status.","title":"Status Is"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","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_credit_unitsArguments","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_site_configurations":{"post":{"operationId":"list_site_configurations","summary":"Show the Chargebee site configuration: product catalog version (v1 or v2) and response schema type per domain. Use for \"","description":"Show the Chargebee site configuration: product catalog version (v1 or v2) and response schema type per domain. Use for \"Is my Chargebee site on product catalog 1.0 or 2.0\".","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"}},"required":["site"],"title":"list_site_configurationsArguments","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}}}}