canonical: https://jentic.com/apis/swaggerhub.hmcts-dts/client-subscriptions-api # Hmcts Dts Client Subscriptions API API for managing client subscriptions as standalone resources. The API exposes 7 endpoints secured with bearer authentication. ## For AI agents Programmatically get list of valid event types for subscription service, create a new client subscription. Covers 7 operations with bearer authentication. ## Scope Does not handle communications, crm, or developer tools - use for payments only. ## Capabilities - Get list of valid event types for subscription service - Create a new client subscription - Retrieve a client subscription by ID - Strict update of a client subscription - Delete a subscription by ID ## Use cases ### Payments Operations Use the Client Subscriptions API to perform payments operations programmatically. The API provides 7 endpoints covering core functionality including get list of valid event types for subscription service, create a new client subscription, retrieve a client subscription by id. Example prompt: Call GET /event-types to get list of valid event types for subscription service ### Automated Subscription Management Automate subscription operations by combining multiple Client Subscriptions API endpoints. Agents can create a new client subscription and then retrieve a client subscription by id in a single workflow. Example prompt: Call POST /client-subscriptions to create a new client subscription, then verify the result ### AI Agent Integration via Jentic AI agents discover and call Client Subscriptions API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually. Example prompt: Search Jentic for 'get list of valid event types for subscription service', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /event-types | Get list of valid event types for subscription service | | POST | /client-subscriptions | Create a new client subscription | | GET | /client-subscriptions/{clientSubscriptionId} | Retrieve a client subscription by ID | | PUT | /client-subscriptions/{clientSubscriptionId} | Strict update of a client subscription | | DELETE | /client-subscriptions/{clientSubscriptionId} | Delete a subscription by ID | | POST | /notifications | Create a client notification. | | GET | /client-subscriptions/{clientSubscriptionId}/documents/{documentId} | Retrieve PDF for the specified document id | ## Key resources - **Subscription** — Operations related to Subscription - **Notification** — Operations related to Notification - **Internal** — Operations related to Internal ## Why Jentic - **Setup:** Wiring the Client Subscriptions API by hand means implementing its bearer JWT auth, coding the subscription, notification, and document calls, and handling retries yourself. Through Jentic you install once, import the Client Subscriptions API from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** This API puts the subscription id in the URL path (/client-subscriptions/{clientSubscriptionId}), so a rule can pin your agent to one subscription: it can read that subscription and its documents and nothing else. You choose the operations it may call, so destructive ones like deleting a subscription are not included unless you add them. - **Credential handling:** Your Client Subscriptions API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list valid event types' or 'get a client subscription by id', and Jentic returns the matching Client Subscriptions API operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Stripe** — Alternative payments API - **Adyen** — Alternative payments API - **Square** — Complementary payments API - **Paypal** — Complementary payments API ## FAQ ### What authentication does the Client Subscriptions API use? The Client Subscriptions API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I get list of valid event types for subscription service with the Client Subscriptions API? Yes. Use the GET /event-types endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the Client Subscriptions API? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I get list of valid event types for subscription service through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get list of valid event types for subscription service'. Jentic returns the matching Client Subscriptions API operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the Client Subscriptions API have? The Client Subscriptions API exposes 7 endpoints covering subscription, notification, internal operations. ### Can I limit what my agent is allowed to do with the Client Subscriptions API? Yes. Because you run Jentic One yourself, your own rules decide which Client Subscriptions API operations and credentials the agent may use. Since the subscription id sits in the URL path (/client-subscriptions/{clientSubscriptionId}), you can pin the agent to a single subscription so it only reads that subscription and its documents. You also choose exactly which operations it may call, so destructive ones like DELETE /client-subscriptions/{clientSubscriptionId} stay off unless you grant them.