List customer subscriptions

Instructions

Implementation Reference

• src/tools/customer-subscriptions.ts:47-52 (handler)

  The handler function that executes the tool logic. It calls client.get('/customer-subscriptions', compact(args)) to fetch the list of customer subscriptions from the DeonPay API.

  safeHandler(async (args) => {
    return client.get(
      "/customer-subscriptions",
      compact(args),
    );
  }),

• src/tools/customer-subscriptions.ts:34-46 (schema)

  Input schema for the tool, defining optional parameters: page, limit, subscription_id (UUID), customer_email (exact match), status (active/paused/cancelled/past_due/completed/trialing), and environment.

  {
    title: "List customer subscriptions",
    description:
      "List individual customer subscriptions (the per-customer rows, NOT the plans). Use this to answer 'who is currently subscribed to plan X', 'how many trialing subscribers do I have', or 'find subscribers on past_due'. Filter by subscription_id (the plan), customer_email (exact, case-insensitive), and status (active/paused/cancelled/past_due/completed/trialing). Each item includes the plan denormalized as a `subscription` sub-object, charges_count, total_charged in centavos, current_period_start/end, next_charge_at, and cancel_at_period_end.",
    inputSchema: {
      page: PageSchema.optional(),
      limit: LimitSchema.optional(),
      subscription_id: z.string().uuid().optional().describe("Filter by plan UUID."),
      customer_email: z.string().email().optional().describe("Exact email match (case-insensitive)."),
      status: CustomerSubscriptionStatusSchema.optional(),
      environment: EnvironmentSchema.optional(),
    },
  },

• src/tools/customer-subscriptions.ts:16-23 (schema)

  Zod enum schema validating subscription status values: active, paused, cancelled, past_due, completed, trialing.

  const CustomerSubscriptionStatusSchema = z.enum([
    "active",
    "paused",
    "cancelled",
    "past_due",
    "completed",
    "trialing",
  ]);

• src/tools/customer-subscriptions.ts:25-53 (registration)

  The registerCustomerSubscriptionTools function that registers the tool on the McpServer with the name 'deonpay_list_customer_subscriptions'.

  export function registerCustomerSubscriptionTools(
    server: McpServer,
    client: DeonpayClient,
  ): void {
    // -------------------------------------------------------------------------
    // deonpay_list_customer_subscriptions
    // -------------------------------------------------------------------------
    server.registerTool(
      "deonpay_list_customer_subscriptions",
      {
        title: "List customer subscriptions",
        description:
          "List individual customer subscriptions (the per-customer rows, NOT the plans). Use this to answer 'who is currently subscribed to plan X', 'how many trialing subscribers do I have', or 'find subscribers on past_due'. Filter by subscription_id (the plan), customer_email (exact, case-insensitive), and status (active/paused/cancelled/past_due/completed/trialing). Each item includes the plan denormalized as a `subscription` sub-object, charges_count, total_charged in centavos, current_period_start/end, next_charge_at, and cancel_at_period_end.",
        inputSchema: {
          page: PageSchema.optional(),
          limit: LimitSchema.optional(),
          subscription_id: z.string().uuid().optional().describe("Filter by plan UUID."),
          customer_email: z.string().email().optional().describe("Exact email match (case-insensitive)."),
          status: CustomerSubscriptionStatusSchema.optional(),
          environment: EnvironmentSchema.optional(),
        },
      },
      safeHandler(async (args) => {
        return client.get(
          "/customer-subscriptions",
          compact(args),
        );
      }),
    );

• src/tools/index.ts:20-29 (registration)

  Top-level registration: registerAllTools calls registerCustomerSubscriptionTools to wire up all customer subscription tools on the MCP server.

  export function registerAllTools(server: McpServer, client: DeonpayClient): void {
    registerLinkTools(server, client);
    registerCheckoutTools(server, client);
    registerTransactionTools(server, client);
    registerProductTools(server, client);
    registerSubscriptionTools(server, client);
    registerCustomerSubscriptionTools(server, client);
    registerCustomerTools(server, client);
    registerMetricsTools(server, client);
  }