create-subscription

Set up recurring product deliveries by specifying variant, quantity, shipping address, payment method, and frequency schedule.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`productVariantID`	Yes
`quantity`	Yes
`addressID`	Yes
`cardID`	Yes
`schedule`	Yes

Implementation Reference

server.js:1039-1069 (handler)

The handler function that implements the core logic for creating a subscription by making a POST request to the terminalApi /subscription endpoint with the provided parameters.

async ({ productVariantID, quantity, addressID, cardID, schedule }) => {
  try {
    const response = await terminalApi.post("/subscription", {
      productVariantID,
      quantity,
      addressID,
      cardID,
      schedule,
    });

    return {
      content: [
        {
          type: "text",
          text: `Subscription created successfully!`,
        },
      ],
    };
  } catch (error) {
    console.error("Error creating subscription:", error);
    return {
      content: [
        {
          type: "text",
          text: `Error creating subscription: ${error.message}`,
        },
      ],
      isError: true,
    };
  }
},

server.js:1029-1038 (schema)

Zod schema defining the input parameters for the create-subscription tool: productVariantID (string), quantity (positive integer), addressID (string), cardID (string), and schedule object.

{
  productVariantID: z.string(),
  quantity: z.number().int().positive(),
  addressID: z.string(),
  cardID: z.string(),
  schedule: z.object({
    type: z.enum(["fixed", "weekly"]),
    interval: z.number().int().positive().optional(),
  }),
},

server.js:1027-1070 (registration)

The server.tool call that registers the 'create-subscription' tool, including its name, input schema, and inline handler function.

server.tool(
  "create-subscription",
  {
    productVariantID: z.string(),
    quantity: z.number().int().positive(),
    addressID: z.string(),
    cardID: z.string(),
    schedule: z.object({
      type: z.enum(["fixed", "weekly"]),
      interval: z.number().int().positive().optional(),
    }),
  },
  async ({ productVariantID, quantity, addressID, cardID, schedule }) => {
    try {
      const response = await terminalApi.post("/subscription", {
        productVariantID,
        quantity,
        addressID,
        cardID,
        schedule,
      });

      return {
        content: [
          {
            type: "text",
            text: `Subscription created successfully!`,
          },
        ],
      };
    } catch (error) {
      console.error("Error creating subscription:", error);
      return {
        content: [
          {
            type: "text",
            text: `Error creating subscription: ${error.message}`,
          },
        ],
        isError: true,
      };
    }
  },
);

Terminal.shop MCP Server