{"openapi":"3.1.0","info":{"title":"Metronome (BYOK) API","version":"0.1.0","description":"Metronome (BYOK) lets an AI assistant read your own Metronome data through the Metronome API with a key you supply (Metronome API token). Read-only: 7 tools (list_customers, get_customer, list_invoices, get_invoice, list_billable_metrics, list_products, list_customer_contracts). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-metronome.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-metronome/docs"},"termsOfService":"https://connectorbay.com/byok-metronome/terms"},"servers":[{"url":"https://byok-metronome.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-metronome/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_customers":{"post":{"operationId":"list_customers","summary":"List customers with name, external id, ingest aliases, billable status and creation time. Paged by cursor. Use for \"Whic","description":"List customers with name, external id, ingest aliases, billable status and creation time. Paged by cursor. Use for \"Which customers are in Metronome\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (1 to 100).","title":"Limit"},"next_page":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next_page field, to fetch the following page.","title":"Next Page"},"ingest_alias":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the customer with this ingest alias.","title":"Ingest Alias"},"only_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only archived customers.","title":"Only Archived"}},"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/get_customer":{"post":{"operationId":"get_customer","summary":"Get one customer by Metronome id: name, external id, ingest aliases, billable status and timestamps. Use for \"Show Metro","description":"Get one customer by Metronome id: name, external id, ingest aliases, billable status and timestamps. Use for \"Show Metronome customer 13117714\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer_id":{"description":"Metronome customer id (UUID).","maxLength":200,"title":"Customer Id","type":"string"}},"required":["customer_id"],"title":"get_customerArguments","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 a customer's invoices with status, type, total, issue date, billing period and contract. Total is in the invoice's ","description":"List a customer's invoices with status, type, total, issue date, billing period and contract. Total is in the invoice's credit type (cents for USD). Use for \"What invoices does Metronome customer 13117714 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer_id":{"description":"Metronome customer id (UUID).","maxLength":200,"title":"Customer Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (1 to 100).","title":"Limit"},"next_page":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next_page field, to fetch the following page.","title":"Next Page"},"status":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Invoice status: DRAFT, FINALIZED or VOID.","title":"Status"},"type":{"anyOf":[{"enum":["USAGE","USAGE_CONSOLIDATED","SCHEDULED"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this invoice type.","title":"Type"},"sort":{"anyOf":[{"enum":["date_asc","date_desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by issue date: date_asc (default) or date_desc.","title":"Sort"},"starting_on":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only invoices whose billing period starts at or after this RFC 3339 time.","title":"Starting On"},"ending_before":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only invoices whose billing period ends before this RFC 3339 time.","title":"Ending Before"},"contract_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Only invoices of this contract id.","title":"Contract Id"}},"required":["customer_id"],"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/get_invoice":{"post":{"operationId":"get_invoice","summary":"Get one invoice by id with status, type, total, dates and contract. Use for \"Show Metronome invoice inv_1\".","description":"Get one invoice by id with status, type, total, dates and contract. Use for \"Show Metronome invoice inv_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer_id":{"description":"Metronome customer id (UUID).","maxLength":200,"title":"Customer Id","type":"string"},"invoice_id":{"description":"Metronome invoice id (UUID).","maxLength":200,"title":"Invoice Id","type":"string"}},"required":["customer_id","invoice_id"],"title":"get_invoiceArguments","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_billable_metrics":{"post":{"operationId":"list_billable_metrics","summary":"List billable metrics: name, aggregation type and key, grouping keys and the SQL that defines them. Use for \"Which billa","description":"List billable metrics: name, aggregation type and key, grouping keys and the SQL that defines them. Use for \"Which billable metrics are defined in Metronome\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (1 to 100).","title":"Limit"},"next_page":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next_page field, to fetch the following page.","title":"Next Page"},"include_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to include archived metrics.","title":"Include Archived"}},"title":"list_billable_metricsArguments","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_products":{"post":{"operationId":"list_products","summary":"List contract-pricing products: id, type, name, tags, billable metric and archive state. Read-only query despite using P","description":"List contract-pricing products: id, type, name, tags, billable metric and archive state. Read-only query despite using POST. Use for \"What products are in the Metronome catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (1 to 100).","title":"Limit"},"next_page":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next_page field, to fetch the following page.","title":"Next Page"},"archive_filter":{"anyOf":[{"enum":["ARCHIVED","NOT_ARCHIVED","ALL"],"type":"string"},{"type":"null"}],"default":null,"description":"Which products: NOT_ARCHIVED (default), ARCHIVED or ALL.","title":"Archive Filter"}},"title":"list_productsArguments","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_customer_contracts":{"post":{"operationId":"list_customer_contracts","summary":"List a customer's contracts (v2): name, rate card, start and end, total contract value and creation time. Pages hold up ","description":"List a customer's contracts (v2): name, rate card, start and end, total contract value and creation time. Pages hold up to 20. Use for \"What contracts does Metronome customer 13117714 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer_id":{"description":"Metronome customer id (UUID).","maxLength":200,"title":"Customer Id","type":"string"},"include_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to include archived contracts.","title":"Include Archived"},"starting_at":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only contracts that started on or after this RFC 3339 time.","title":"Starting At"},"limit":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many contracts per page (1 to 20).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's cursor field, for the following page.","title":"Cursor"}},"required":["customer_id"],"title":"list_customer_contractsArguments","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}}}}