{"openapi":"3.1.0","info":{"title":"Stripe Catalog (BYOK) API","version":"0.1.0","description":"Stripe Catalog (BYOK) lets an AI assistant read your own Stripe Catalog data through the Stripe Catalog API with a key you supply (restricted API key with read permissions only (starts with rk_live_ or rk_test_)). Read-only: 12 tools (list_prices, get_price, list_plans, list_coupons, get_coupon, list_promotion_codes, list_shipping_rates, list_entitlement_features, list_active_entitlements,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-stripe-catalog.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-stripe-catalog/docs"},"termsOfService":"https://connectorbay.com/byok-stripe-catalog/terms"},"servers":[{"url":"https://byok-stripe-catalog.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-stripe-catalog/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_prices":{"post":{"operationId":"list_prices","summary":"List prices (what and how you charge for a product) with currency, unit amount, billing interval and lookup key. Amounts","description":"List prices (what and how you charge for a product) with currency, unit amount, billing interval and lookup key. Amounts are in the smallest currency unit. Works with a restricted key that has read access to this resource only. Use for \"What recurring prices do I have for product prod_NWjs8kKbJWmuuc\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only prices for this product id, for example prod_NWjs8kKbJWmuuc.","title":"Product"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active prices only, false for archived ones.","title":"Active"},"type":{"anyOf":[{"enum":["one_time","recurring"],"type":"string"},{"type":"null"}],"default":null,"description":"Only one_time or recurring prices.","title":"Type"},"currency":{"anyOf":[{"maxLength":3,"type":"string"},{"type":"null"}],"default":null,"description":"Only prices in this lowercase three-letter currency code, for example usd.","title":"Currency"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_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/get_price":{"post":{"operationId":"get_price","summary":"Get one price by id with its amount, currency, interval, tax behavior and lookup key. Works with a restricted key that h","description":"Get one price by id with its amount, currency, interval, tax behavior and lookup key. Works with a restricted key that has read access to this resource only. Use for \"What does price price_1MoBy5LkdIwHu7ixZhnattbh cost\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"price":{"description":"Price id, for example price_1MoBy5LkdIwHu7ixZhnattbh.","maxLength":200,"title":"Price","type":"string"}},"required":["price"],"title":"get_priceArguments","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 legacy plans (the older form of recurring prices) with amount, interval, trial days and usage type. Works with a re","description":"List legacy plans (the older form of recurring prices) with amount, interval, trial days and usage type. Works with a restricted key that has read access to this resource only. Use for \"Which legacy plans are still active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only plans for this product id.","title":"Product"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active plans only, false for archived ones.","title":"Active"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"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}},"/v1/tools/list_coupons":{"post":{"operationId":"list_coupons","summary":"List coupons with percent or amount off, duration, redemption counts and validity. Works with a restricted key that has ","description":"List coupons with percent or amount off, duration, redemption counts and validity. Works with a restricted key that has read access to this resource only. Use for \"Which coupons can still be redeemed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_couponsArguments","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_coupon":{"post":{"operationId":"get_coupon","summary":"Get one coupon by id: discount, duration, redemption limit and how often it was redeemed. Works with a restricted key th","description":"Get one coupon by id: discount, duration, redemption limit and how often it was redeemed. Works with a restricted key that has read access to this resource only. Use for \"How many times was coupon SUMMER25 redeemed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"coupon":{"description":"Coupon id, for example SUMMER25.","maxLength":200,"title":"Coupon","type":"string"}},"required":["coupon"],"title":"get_couponArguments","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_promotion_codes":{"post":{"operationId":"list_promotion_codes","summary":"List customer-facing promotion codes with the coupon behind each, expiry, redemption counts and minimum order restrictio","description":"List customer-facing promotion codes with the coupon behind each, expiry, redemption counts and minimum order restriction. Works with a restricted key that has read access to this resource only. Use for \"Is the promotion code WELCOME10 still active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only promotion codes with this code (case-insensitive), for example WELCOME10.","title":"Code"},"coupon":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only promotion codes for this coupon id.","title":"Coupon"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active codes only, false for inactive ones.","title":"Active"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_promotion_codesArguments","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_shipping_rates":{"post":{"operationId":"list_shipping_rates","summary":"List shipping rates with display name, fixed amount, currency, tax behavior and delivery estimate. Amounts are in the sm","description":"List shipping rates with display name, fixed amount, currency, tax behavior and delivery estimate. Amounts are in the smallest currency unit. Works with a restricted key that has read access to this resource only. Use for \"Which shipping rates can customers pick at checkout\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active rates only, false for archived ones.","title":"Active"},"currency":{"anyOf":[{"maxLength":3,"type":"string"},{"type":"null"}],"default":null,"description":"Only rates in this lowercase three-letter currency code.","title":"Currency"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_shipping_ratesArguments","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_entitlement_features":{"post":{"operationId":"list_entitlement_features","summary":"List entitlement features (named capabilities you can attach to products) with lookup key and active state. Works with a","description":"List entitlement features (named capabilities you can attach to products) with lookup key and active state. Works with a restricted key that has read access to this resource only. Use for \"Which entitlement features have I defined\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for archived features only, false for unarchived ones.","title":"Archived"},"lookup_key":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the feature with this lookup key.","title":"Lookup Key"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_entitlement_featuresArguments","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_active_entitlements":{"post":{"operationId":"list_active_entitlements","summary":"List the features one customer is currently entitled to, with feature id and lookup key. Works with a restricted key tha","description":"List the features one customer is currently entitled to, with feature id and lookup key. Works with a restricted key that has read access to this resource only. Use for \"Which features is customer cus_NffrFeUfNV2Hib entitled to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer":{"description":"Customer id whose active entitlements to list, for example cus_NffrFeUfNV2Hib.","maxLength":100,"title":"Customer","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"required":["customer"],"title":"list_active_entitlementsArguments","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_product_features":{"post":{"operationId":"list_product_features","summary":"List the entitlement features attached to one product. Use for \"Which features come with product prod_NWjs8kKbJWmuuc\".","description":"List the entitlement features attached to one product. Use for \"Which features come with product prod_NWjs8kKbJWmuuc\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product":{"description":"Product id, for example prod_NWjs8kKbJWmuuc.","maxLength":200,"title":"Product","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"required":["product"],"title":"list_product_featuresArguments","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_links":{"post":{"operationId":"list_payment_links","summary":"List payment links with their public URL, active state, currency, submit type and whether they create subscriptions. Wor","description":"List payment links with their public URL, active state, currency, submit type and whether they create subscriptions. Works with a restricted key that has read access to this resource only. Use for \"Which payment links are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active links only, false for deactivated ones.","title":"Active"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_payment_linksArguments","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_link_line_items":{"post":{"operationId":"list_payment_link_line_items","summary":"List the line items of one payment link with description, quantity, amounts and currency. Works with a restricted key th","description":"List the line items of one payment link with description, quantity, amounts and currency. Works with a restricted key that has read access to this resource only. Use for \"What does payment link plink_1OkT7LLkdIwHu7ixwDX6bYHx sell\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"payment_link":{"description":"Payment link id, for example plink_1OkT7LLkdIwHu7ixwDX6bYHx.","maxLength":200,"title":"Payment Link","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"required":["payment_link"],"title":"list_payment_link_line_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}}}}