Skip to main content
The subscriptions module provides tools to view client subscriptions, membership products, and contracts.

Available Tools

list_subscriptions

List client memberships and active subscriptions.
  • Type: Read-only
  • Important Input Fields:
    • clientId (string, optional): Filter subscriptions for a specific client.
    • status (string, optional): Filter by status (e.g. active, paused, expired).
    • page (integer, optional): Page number.
    • limit (integer, optional): Items per page.

get_subscription

Retrieve full details of a specific client subscription.
  • Type: Read-only
  • Important Input Fields:
    • subscriptionId (string, required): Unique identifier for the client’s subscription.

list_membership_products

List the company’s catalog of purchasable membership packages.
  • Type: Read-only
  • Important Input Fields:
    • page (integer, optional): Page number.
    • limit (integer, optional): Items per page.

Natural Language Examples

  • “Does client client_5f81 have an active membership subscription?”
  • “List all membership products we sell.”

JSON-RPC Call Example (list_subscriptions)