{"openapi":"3.1.0","info":{"title":"HubSpot Revenue (BYOK) API","version":"0.1.0","description":"HubSpot Revenue (BYOK) lets an AI assistant read your own HubSpot Revenue data through the HubSpot Revenue API with a key you supply (HubSpot private app access token (scopes: cpq.price_books.read, commerce.payment_accounts.read, commerce.payment_links.read as needed)). Read-only: 6 tools (list_price_books, get_price_book, list_price_book_items, list_payment_links, get_payment_link,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-hubspot-revenue.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hubspot-revenue/docs"},"termsOfService":"https://connectorbay.com/byok-hubspot-revenue/terms"},"servers":[{"url":"https://byok-hubspot-revenue.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hubspot-revenue/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_books":{"post":{"operationId":"list_price_books","summary":"List price books with name, status, description, number of products, supported currencies and dates. Use for \"Which pric","description":"List price books with name, status, description, number of products, supported currencies and dates. Use for \"Which price books do we have in HubSpot\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: paging.next.after from the previous answer. Leave out for the first page.","title":"After"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only archived price books.","title":"Archived"}},"title":"list_price_booksArguments","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_book":{"post":{"operationId":"get_price_book","summary":"Get one price book by id: name, status, description, product count, currencies, auto-assignment flag and dates. Use for ","description":"Get one price book by id: name, status, description, product count, currencies, auto-assignment flag and dates. Use for \"Is HubSpot price book 301 active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"price_book_id":{"description":"Id of the price book (a numeric string such as '301').","maxLength":200,"title":"Price Book Id","type":"string"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to look up an archived price book.","title":"Archived"}},"required":["price_book_id"],"title":"get_price_bookArguments","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_price_book_items":{"post":{"operationId":"list_price_book_items","summary":"List the products in a price book with name, SKU, product type, billing frequency, status and pricing model. Use for \"Wh","description":"List the products in a price book with name, SKU, product type, billing frequency, status and pricing model. Use for \"What products are in HubSpot price book 301\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"price_book_id":{"description":"Id of the price book (a numeric string such as '301').","maxLength":200,"title":"Price Book Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: paging.next.after from the previous answer. Leave out for the first page.","title":"After"}},"required":["price_book_id"],"title":"list_price_book_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_payment_links":{"post":{"operationId":"list_payment_links","summary":"List payment links with currency, completed purchase count, tax and discount settings and dates. No buyer data. Use for ","description":"List payment links with currency, completed purchase count, tax and discount settings and dates. No buyer data. Use for \"Which HubSpot payment links have been used the most\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: paging.next.after from the previous answer. Leave out for the first page.","title":"After"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only archived payment links.","title":"Archived"}},"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/get_payment_link":{"post":{"operationId":"get_payment_link","summary":"Get one payment link by id: currency, completed purchases, tax, discount and shipping settings, and dates. Use for \"How ","description":"Get one payment link by id: currency, completed purchases, tax, discount and shipping settings, and dates. Use for \"How many purchases did HubSpot payment link 9001 complete\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"payment_link_id":{"description":"Id of the payment link (a numeric string such as '9001').","maxLength":200,"title":"Payment Link Id","type":"string"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to look up an archived link.","title":"Archived"}},"required":["payment_link_id"],"title":"get_payment_linkArguments","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_payment_account_status":{"post":{"operationId":"get_payment_account_status","summary":"Show whether the account's HubSpot payments setup can take payments and pay out, its processor type and enrollment state","description":"Show whether the account's HubSpot payments setup can take payments and pay out, its processor type and enrollment state. Use for \"Is our HubSpot payments account active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_payment_account_statusArguments","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}}}}