canonical: https://jentic.com/apis/connect.cloudblue.com/cloudblue-connect # Connect Cloudblue CloudBlue Connect API The CloudBlue Connect API is the programmatic interface for CloudBlue's cloud commerce and supply automation platform used by distributors, MSPs, and telcos to publish and resell SaaS subscriptions. It exposes 861 endpoints across catalog, agreements, contracts, marketplaces, listings, offers, products, subscriptions (assets and requests), customers, partners, billing, usage reporting, and helpdesk. Vendors use it to manage product catalog and onboarding, while distributors and resellers use it to manage agreements, marketplaces, and end-customer subscription lifecycles. ## For AI agents Manage CloudBlue Connect catalog, agreements, marketplaces, subscriptions, and billing for SaaS distribution. Useful for agents that automate vendor onboarding, subscription provisioning, or partner reporting. ## Scope Does not handle direct card or bank payment processing, end-user identity, or product runtime delivery - use for SaaS catalog, agreement, and subscription management only. ## Capabilities - Onboard a new vendor product into the catalog with versions, items, and parameters - Create and version distribution and program agreements between vendors, distributors, and resellers - List subscription assets across customers and inspect their parameters and items - Approve, reject, or fulfill subscription requests as part of a provisioning workflow - Configure marketplaces and hubs to control which products are available in which regions - Pull usage reports and billing statements for chargeback and revenue recognition - Handle helpdesk conversations and notification rules tied to subscription lifecycle events ## Use cases ### Automated Subscription Provisioning When a reseller submits a purchase order, the agent picks up the new subscription request via GET `/subscriptions/requests`, validates the requested items, and approves or rejects it through the CloudBlue Connect provisioning workflow. The same flow handles change and cancel requests, so the entire subscription lifecycle stays in CloudBlue without manual operator clicks. Operators report cycle time falling from a day to minutes when this is wired up. Example prompt: Poll GET `/subscriptions/requests` every minute, and for each pending request call PUT `/subscriptions/requests/{id}/attributes` followed by the request approval endpoint to mark it fulfilled. ### Vendor Catalog Onboarding Streamline new product onboarding by scripting the catalog setup. The agent creates a product, attaches versions and items, sets pricing, and publishes it to the appropriate marketplaces. CloudBlue Connect models all of this as catalog, agreements, and listings resources, and the API exposes each step. This is the difference between weeks of manual onboarding and a same-day rollout for a new vendor. Example prompt: Create a product version via the products endpoints, then list it on marketplaces MP-A and MP-B by creating the corresponding listings entries. ### Partner Billing and Usage Reporting Pull usage and billing data for a billing cycle and reconcile it against an internal ERP. The agent fetches usage reports, statements, and metrics endpoints, joins by customer and product, and emits a CSV for finance. This avoids exporting from the CloudBlue UI and gives finance an idempotent, automated input each cycle. Example prompt: Fetch usage reports for billing cycle 2026-Q2 across all marketplaces and emit a usage-2026-q2.csv with customer, product, units, and amount columns. ### AI Agent Marketplace Operations via Jentic Give a CSM or operations assistant the ability to answer questions and take simple actions across the CloudBlue catalog. The agent searches Jentic for find a cloudblue subscription, loads the matching operation schema, and executes it with the API key isolated in your Jentic One instance. Because CloudBlue exposes 861 operations, agent-side discovery is what makes the surface area usable. Example prompt: Through Jentic, search find a cloudblue subscription, load the GET `/subscriptions/assets/{id}` schema, and execute it for asset AS-9876 to return its current status and parameters. ## Key resources - **Subscriptions** — Manage subscription assets and the requests that change them (purchase, change, cancel) - **Agreements** — Create and version distribution, program, and service-level agreements between parties - **Catalog** — Manage products, versions, items, parameters, and configurations - **Listings** — Publish products to marketplaces and manage their availability - **Marketplaces** — Configure marketplaces, hubs, and the regions products are available in - **Customers** — Manage end-customer accounts in the marketplace - **Partners** — Manage vendor, distributor, and reseller partner accounts - **Usage Reporting** — Submit and retrieve metered usage records for billing - **Helpdesk** — Manage conversations and tickets tied to subscriptions ## Why Jentic - **Setup:** Wiring CloudBlue Connect by hand means handling its Authorization-header api_key auth and navigating an 861-operation surface across catalog, agreements, and subscriptions yourself. Through Jentic you install once, import the CloudBlue Connect API from the API Directory, store the api_key once, and your agent calls it. - **Permission scoping:** With this many operations, you limit the agent to the ones it needs, such as approving a subscription request or reading an agreement, and it can call nothing outside that set. State-changing operations like fulfilment approval or subscription termination are only reachable if you include them in what the agent is allowed to call. - **Credential handling:** Your CloudBlue Connect api_key is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'approve a CloudBlue subscription request', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs, which matters given the large operation surface. ## Related APIs - **Zuora API** — Zuora is a subscription billing and revenue platform with broad enterprise adoption - **Recurly API** — Recurly is a hosted subscription billing service for direct-to-consumer SaaS - **Stripe API** — Stripe handles the underlying card and bank payment rails ## FAQ ### What authentication does the CloudBlue Connect API use? It uses an API key passed in the Authorization header (the Apikey0 scheme). Keys are issued from the Connect UI under integration tokens. Through Jentic the key lives in the vault and is added server-side, so the raw header value never enters the agent's prompt. ### Can I approve a subscription purchase request through the API? Yes. The `/subscriptions/requests` endpoints expose the full request lifecycle. You PUT attribute updates to `/subscriptions/requests/{id}/attributes` and call the appropriate request action endpoint to approve, fail, or revoke it. This is the supported path for fulfilling vendor or distributor automation. ### How do I list every subscription asset for a specific customer? Call GET `/subscriptions/assets` with a filter on the customer's tier identifier. The endpoint paginates and supports rich filters on status, marketplace, and product, so an agent can scope down to one customer or one product family without overfetching. ### Does the API cover usage-based billing reporting? Yes. The Usage Reporting and Statistics endpoints accept and expose metered usage records and aggregated statements. Vendors submit usage records per billing period and distributors retrieve statements for chargeback. This is the supported path for usage-priced products in the catalog. ### How many endpoints does the CloudBlue Connect API expose? The current spec includes 861 endpoints across the catalog, agreements, subscriptions, listings, marketplaces, billing, and helpdesk surfaces. Discovery via the docs portal is heavy, so agent-side intent search through Jentic is recommended over manual browsing. ### How do I work with CloudBlue Connect through Jentic? Run pip install jentic, then await client.search('approve a cloudblue subscription request'), load the matching operation schema, and execute it. The underlying call is one of the `/subscriptions/requests` endpoints scoped to the request ID you supply at runtime. ### Can I limit what my agent is allowed to do with the CloudBlue Connect API? Yes. Because Jentic One is self-hosted, you decide which of the CloudBlue Connect API's 861 operations your agent can call, and it can reach nothing outside that set. You can allow read-only calls such as listing subscription assets or retrieving an agreement while withholding state-changing operations like approving a subscription request or terminating a subscription. Those operations become callable only when you explicitly include them in the agent's allowed set, and your stored API key is injected at execution time under your own rules.