create-subscription
Create recurring subscriptions for products on Terminal.shop by specifying product variant, quantity, address, payment card, and delivery schedule.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| addressID | Yes | ||
| cardID | Yes | ||
| productVariantID | Yes | ||
| quantity | Yes | ||
| schedule | Yes |
Implementation Reference
- server.js:1040-1070 (handler)Handler function that implements the core logic of creating a subscription by posting the provided parameters to the /subscription endpoint via terminalApi.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:1030-1039 (schema)Zod schema defining the input parameters for the create-subscription tool: productVariantID, quantity, addressID, cardID, 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(), }), }, async ({ productVariantID, quantity, addressID, cardID, schedule }) => {
- server.js:1028-1070 (registration)Registration of the 'create-subscription' tool using server.tool, including name, input schema, and handler function."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, }; } }, );