Seal Subscriptions MCP by usefulapi is an MCP server published by io.usefulapi, hosted at seal-subscriptions.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 28 tools, including sealsubscriptions_list_subscriptions, sealsubscriptions_list_subscriptions_by_billing_date, sealsubscriptions_get_subscription, sealsubscriptions_list_subscription_rules, sealsubscriptions_get_subscription_rule.
Manage Seal Subscriptions on Shopify: subscriptions, billing attempts, items, discounts, rules.
4,297 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
List or search the shop's subscriptions (up to 50 per page; pass next_cursor as cursor for the next page): status, customer, interval, total value, shipping address and card brand/last digits. Search by customer email, first or last name; filter by status; optionally include the items and the billing attempts of each. GET /subscriptions.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Deprecated: only page 1 is accepted. For later pages use the returned next_cursor as cursor. |
| query | string | Search text: customer email, first name or last name. |
| cursor | string | Opaque next_cursor from the previous reply; omit for the first page. Keep the same filters. |
| status | string | Only subscriptions in this status (default: all). |
| with_items | boolean | Include each subscription's items (default false). |
| with_billing_attempts | boolean | Include each subscription's billing attempts (default false). |
{
"name": "sealsubscriptions_list_subscriptions",
"title": "List subscriptions",
"description": "List or search the shop's subscriptions (up to 50 per page; pass next_cursor as cursor for the next page): status, customer, interval, total value, shipping address and card brand/last digits. Search by customer email, first or last name; filter by status; optionally include the items and the billing attempts of each. GET /subscriptions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Deprecated: only page 1 is accepted. For later pages use the returned next_cursor as cursor.",
"exclusiveMinimum": 0
},
"query": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Search text: customer email, first name or last name."
},
"cursor": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Opaque next_cursor from the previous reply; omit for the first page. Keep the same filters."
},
"status": {
"enum": [
"active",
"paused",
"cancelled"
],
"type": "string",
"description": "Only subscriptions in this status (default: all)."
},
"with_items": {
"type": "boolean",
"description": "Include each subscription's items (default false)."
},
"with_billing_attempts": {
"type": "boolean",
"description": "Include each subscription's billing attempts (default false)."
}
}
},
"annotations": {
"title": "List subscriptions",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Subscriptions that have at least one billing attempt scheduled between two UTC date-times: the way to see what will be charged tomorrow or this week. Each subscription carries a cursor; pass the last one's cursor as `cursor` to get the next page. GET /subscriptions-by-billing-date.
| Parameter | Type | Description |
|---|---|---|
| cursor | string | Cursor of the last subscription of the previous page. |
| to_datetime * | string | End of the period in UTC, yyyy-mm-ddThh:mm:ss, e.g. 2030-12-24T23:59:59. |
| from_datetime * | string | Start of the period in UTC, yyyy-mm-ddThh:mm:ss, e.g. 2030-12-24T00:00:00. |
{
"name": "sealsubscriptions_list_subscriptions_by_billing_date",
"title": "List subscriptions by billing date",
"description": "Subscriptions that have at least one billing attempt scheduled between two UTC date-times: the way to see what will be charged tomorrow or this week. Each subscription carries a cursor; pass the last one's cursor as `cursor` to get the next page. GET /subscriptions-by-billing-date.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"from_datetime",
"to_datetime"
],
"properties": {
"cursor": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Cursor of the last subscription of the previous page."
},
"to_datetime": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"description": "End of the period in UTC, yyyy-mm-ddThh:mm:ss, e.g. 2030-12-24T23:59:59."
},
"from_datetime": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"description": "Start of the period in UTC, yyyy-mm-ddThh:mm:ss, e.g. 2030-12-24T00:00:00."
}
}
},
"annotations": {
"title": "List subscriptions by billing date",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One subscription with everything Seal knows: customer, shipping and billing address, status, intervals, delivery method, items with discounts, billing attempts (with status and error messages), fulfillment orders, invoices, tags and the activity log. Private customer links are removed. GET /subscription?id=.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_get_subscription",
"title": "Get subscription",
"description": "One subscription with everything Seal knows: customer, shipping and billing address, status, intervals, delivery method, items with discounts, billing attempts (with status and error messages), fulfillment orders, invoices, tags and the activity log. Private customer links are removed. GET /subscription?id=.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get subscription",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the subscription rules (plans) of the shop: name, payment type, the products and variants they apply to and their selling plans. GET /subscription-rules.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1); 50 per page. Pass the previous reply's next_page. |
{
"name": "sealsubscriptions_list_subscription_rules",
"title": "List subscription rules",
"description": "List the subscription rules (plans) of the shop: name, payment type, the products and variants they apply to and their selling plans. GET /subscription-rules.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1); 50 per page. Pass the previous reply's next_page.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List subscription rules",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One subscription rule by id, with its products, variants and selling plans. GET /subscription-rule?id=.
| Parameter | Type | Description |
|---|---|---|
| rule_id * | integer | Subscription rule id (from sealsubscriptions_list_subscription_rules). |
{
"name": "sealsubscriptions_get_subscription_rule",
"title": "Get subscription rule",
"description": "One subscription rule by id, with its products, variants and selling plans. GET /subscription-rule?id=.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"rule_id"
],
"properties": {
"rule_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Subscription rule id (from sealsubscriptions_list_subscription_rules).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get subscription rule",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Read a subscription rule's complete selling plans, including initial/fixed and recurring pricing policies, cycle thresholds, billing and delivery intervals. Returns Seal's original field names and values. Read only: Seal's public API does not support editing these policies or reading/creating/updating automated interval-change rules; configure those in the Seal app. Does not change existing contracts. GET /subscription-rule?id=.
| Parameter | Type | Description |
|---|---|---|
| rule_id * | integer | Subscription rule id from sealsubscriptions_list_subscription_rules. |
{
"name": "sealsubscriptions_list_selling_plans",
"title": "List selling plans",
"description": "Read a subscription rule's complete selling plans, including initial/fixed and recurring pricing policies, cycle thresholds, billing and delivery intervals. Returns Seal's original field names and values. Read only: Seal's public API does not support editing these policies or reading/creating/updating automated interval-change rules; configure those in the Seal app. Does not change existing contracts. GET /subscription-rule?id=.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"rule_id"
],
"properties": {
"rule_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Subscription rule id from sealsubscriptions_list_subscription_rules.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List selling plans",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the webhooks registered for this shop through the API (topic and address). GET /webhooks.
No parameters.
{
"name": "sealsubscriptions_list_webhooks",
"title": "List webhooks",
"description": "List the webhooks registered for this shop through the API (topic and address). GET /webhooks.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List webhooks",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: Pause an active subscription: no further charges or shipments until it is resumed. Undo with sealsubscriptions_resume_subscription. PUT /subscription action=pause.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_pause_subscription",
"title": "Pause subscription",
"description": "WRITE: Pause an active subscription: no further charges or shipments until it is resumed. Undo with sealsubscriptions_resume_subscription. PUT /subscription action=pause.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Pause subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Resume a paused subscription so charges and shipments continue on the schedule. PUT /subscription action=resume.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_resume_subscription",
"title": "Resume subscription",
"description": "WRITE: Resume a paused subscription so charges and shipments continue on the schedule. PUT /subscription action=resume.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Resume subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Reactivate a cancelled subscription (the effect is the same as resume; use this for cancelled ones). Charges restart on the schedule, so the customer may be billed. PUT /subscription action=reactivate.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_reactivate_subscription",
"title": "Reactivate subscription",
"description": "WRITE: Reactivate a cancelled subscription (the effect is the same as resume; use this for cancelled ones). Charges restart on the schedule, so the customer may be billed. PUT /subscription action=reactivate.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Reactivate subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Cancel a subscription now: all future charges and shipments stop and the customer may get Seal's cancellation email. It can be brought back with sealsubscriptions_reactivate_subscription. For a later cancellation use sealsubscriptions_schedule_cancellation. PUT /subscription action=cancel.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_cancel_customer_subscription",
"title": "Cancel subscription",
"description": "WRITE: Cancel a subscription now: all future charges and shipments stop and the customer may get Seal's cancellation email. It can be brought back with sealsubscriptions_reactivate_subscription. For a later cancellation use sealsubscriptions_schedule_cancellation. PUT /subscription action=cancel.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Cancel subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Schedule the cancellation of a subscription for a future date and time (it stays active until then). PUT /subscription-schedule-cancellation.
| Parameter | Type | Description |
|---|---|---|
| date * | string | Cancellation date, yyyy-mm-dd. |
| time * | string | Cancellation time, hh:mm (24-hour), in the given timezone. |
| timezone * | string | UTC offset of the date and time, e.g. +00:00 or -04:00. |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_schedule_cancellation",
"title": "Schedule subscription cancellation",
"description": "WRITE: Schedule the cancellation of a subscription for a future date and time (it stays active until then). PUT /subscription-schedule-cancellation.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"date",
"time",
"timezone"
],
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Cancellation date, yyyy-mm-dd."
},
"time": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"description": "Cancellation time, hh:mm (24-hour), in the given timezone."
},
"timezone": {
"type": "string",
"pattern": "^[+-]([01]\\d|2[0-3]):[0-5]\\d$",
"description": "UTC offset of the date and time, e.g. +00:00 or -04:00."
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Schedule subscription cancellation",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Add products to a subscription. Prices are in the subscription's currency and change what the customer pays on the next charge. An item with one_time=true is removed after the next renewal. PUT /subscription action=add_items.
| Parameter | Type | Description |
|---|---|---|
| items * | array | |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_add_items",
"title": "Add items to subscription",
"description": "WRITE: Add products to a subscription. Prices are in the subscription's currency and change what the customer pays on the next charge. An item with one_time=true is removed after the next renewal. PUT /subscription action=add_items.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"product_id",
"variant_id",
"quantity",
"title",
"price"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 200
},
"price": {
"type": "number",
"minimum": 0,
"description": "Unit price in the subscription's currency."
},
"title": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Product and variant title."
},
"taxable": {
"type": "boolean",
"description": "Default true."
},
"one_time": {
"type": "boolean",
"description": "Remove the item after the next renewal (default false)."
},
"quantity": {
"type": "integer",
"maximum": 10000,
"exclusiveMinimum": 0
},
"product_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,20}$"
},
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
],
"description": "Shopify product id."
},
"properties": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"maxLength": 2000
}
}
},
"maxItems": 50,
"description": "Line item properties as { key, value } pairs."
},
"variant_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,20}$"
},
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
],
"description": "Shopify variant id."
},
"requires_shipping": {
"type": "boolean",
"description": "Default true."
}
}
},
"maxItems": 50,
"minItems": 1
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Add items to subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: Change existing items of a subscription: variant, quantity (> 0), price (>= 0), SKU, one-time flag, properties. Changes what the customer pays on the next charge. PUT /subscription action=edit_items.
| Parameter | Type | Description |
|---|---|---|
| items * | array | |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_edit_items",
"title": "Edit subscription items",
"description": "WRITE: Change existing items of a subscription: variant, quantity (> 0), price (>= 0), SKU, one-time flag, properties. Changes what the customer pays on the next charge. PUT /subscription action=edit_items.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Subscription item id (items[].id from sealsubscriptions_get_subscription).",
"exclusiveMinimum": 0
},
"sku": {
"type": "string",
"maxLength": 200
},
"price": {
"type": "number",
"minimum": 0,
"description": "Unit price in the subscription's currency."
},
"title": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"one_time": {
"type": "boolean",
"description": "Remove the item after the next renewal."
},
"quantity": {
"type": "integer",
"maximum": 10000,
"exclusiveMinimum": 0
},
"properties": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"maxLength": 2000
}
}
},
"maxItems": 50,
"description": "Line item properties as { key, value } pairs."
},
"variant_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,20}$"
},
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
],
"description": "Switch the item to this Shopify variant id."
}
}
},
"maxItems": 50,
"minItems": 1
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Edit subscription items",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Remove items from a subscription by item id. The customer stops receiving and paying for them. PUT /subscription action=remove_items.
| Parameter | Type | Description |
|---|---|---|
| item_ids * | array | |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_remove_items",
"title": "Remove items from subscription",
"description": "WRITE: Remove items from a subscription by item id. The customer stops receiving and paying for them. PUT /subscription action=remove_items.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"item_ids"
],
"properties": {
"item_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Subscription item id (items[].id from sealsubscriptions_get_subscription).",
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Remove items from subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Edit a subscription's schedule and details: delivery and billing interval (a billing interval longer than the delivery interval makes it prepaid), min/max number of payments, note attributes (an empty list removes them), delivery method and price, and the shipping address. Only the fields you pass change. To change items use the item tools. PUT /subscription action=edit.
| Parameter | Type | Description |
|---|---|---|
| s_zip | string | |
| s_city | string | |
| s_phone | string | |
| s_company | string | |
| s_country | string | |
| s_address1 | string | |
| s_address2 | string | |
| s_province | string | |
| s_last_name | string | |
| s_first_name | string | |
| delivery_price | number |
WRITE: Move a billing attempt that has not been processed yet to another date and time. With reset_schedule=true the later attempts are rebuilt from the new date. PUT /subscription-billing-attempt action=reschedule.
| Parameter | Type | Description |
|---|---|---|
| date * | string | New date, yyyy-mm-dd. |
| time * | string | New time, hh:mm (24-hour), in the given timezone. |
| timezone * | string | UTC offset of the date and time, e.g. +00:00 or -04:00. |
| reset_schedule | boolean | Rebuild the rest of the schedule after this attempt (default false). |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
| billing_attempt_id * | integer | Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription). |
{
"name": "sealsubscriptions_reschedule_billing_attempt",
"title": "Reschedule billing attempt",
"description": "WRITE: Move a billing attempt that has not been processed yet to another date and time. With reset_schedule=true the later attempts are rebuilt from the new date. PUT /subscription-billing-attempt action=reschedule.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"billing_attempt_id",
"date",
"time",
"timezone"
],
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "New date, yyyy-mm-dd."
},
"time": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"description": "New time, hh:mm (24-hour), in the given timezone."
},
"timezone": {
"type": "string",
"pattern": "^[+-]([01]\\d|2[0-3]):[0-5]\\d$",
"description": "UTC offset of the date and time, e.g. +00:00 or -04:00."
},
"reset_schedule": {
"type": "boolean",
"description": "Rebuild the rest of the schedule after this attempt (default false)."
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
},
"billing_attempt_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Reschedule billing attempt",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Skip one upcoming billing attempt so the customer is not charged for that cycle. Undo with sealsubscriptions_unskip_billing_attempt. PUT /subscription-billing-attempt action=skip.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
| billing_attempt_id * | integer | Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription). |
{
"name": "sealsubscriptions_skip_billing_attempt",
"title": "Skip billing attempt",
"description": "WRITE: Skip one upcoming billing attempt so the customer is not charged for that cycle. Undo with sealsubscriptions_unskip_billing_attempt. PUT /subscription-billing-attempt action=skip.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"billing_attempt_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
},
"billing_attempt_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Skip billing attempt",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Bring back a skipped billing attempt, so it is charged on its date again. PUT /subscription-billing-attempt action=unskip.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
| billing_attempt_id * | integer | Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription). |
{
"name": "sealsubscriptions_unskip_billing_attempt",
"title": "Unskip billing attempt",
"description": "WRITE: Bring back a skipped billing attempt, so it is charged on its date again. PUT /subscription-billing-attempt action=unskip.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"billing_attempt_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
},
"billing_attempt_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Unskip billing attempt",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Delete a billing attempt that has not been processed. Seal keeps 65 days of attempts scheduled, so a deleted one is recreated within hours unless the schedule is moved first (see sealsubscriptions_reschedule_billing_attempt). DELETE /subscription-billing-attempt.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
| billing_attempt_id * | integer | Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription). |
{
"name": "sealsubscriptions_delete_billing_attempt",
"title": "Delete billing attempt",
"description": "WRITE: Delete a billing attempt that has not been processed. Seal keeps 65 days of attempts scheduled, so a deleted one is recreated within hours unless the schedule is moved first (see sealsubscriptions_reschedule_billing_attempt). DELETE /subscription-billing-attempt.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"billing_attempt_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
},
"billing_attempt_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Delete billing attempt",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Move a fulfillment order of a prepaid subscription to another date and time. PUT /subscription-fulfillment-order action=reschedule.
| Parameter | Type | Description |
|---|---|---|
| date * | string | New date, yyyy-mm-dd. |
| time * | string | New time, hh:mm (24-hour), in the given timezone. |
| timezone * | string | UTC offset of the date and time, e.g. +00:00 or -04:00. |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
| fulfillment_order_id * | integer | Fulfillment order id (fulfillment_orders[].id from sealsubscriptions_get_subscription). |
{
"name": "sealsubscriptions_reschedule_fulfillment_order",
"title": "Reschedule fulfillment order",
"description": "WRITE: Move a fulfillment order of a prepaid subscription to another date and time. PUT /subscription-fulfillment-order action=reschedule.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"fulfillment_order_id",
"date",
"time",
"timezone"
],
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "New date, yyyy-mm-dd."
},
"time": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"description": "New time, hh:mm (24-hour), in the given timezone."
},
"timezone": {
"type": "string",
"pattern": "^[+-]([01]\\d|2[0-3]):[0-5]\\d$",
"description": "UTC offset of the date and time, e.g. +00:00 or -04:00."
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
},
"fulfillment_order_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Fulfillment order id (fulfillment_orders[].id from sealsubscriptions_get_subscription).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Reschedule fulfillment order",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: CHARGES THE CUSTOMER'S PAYMENT METHOD IMMEDIATELY for the next billing attempt of the subscription and creates a Shopify order; it does not wait for the scheduled date. Only call it when the user clearly asked for an immediate charge. With reset_schedule=true the later attempts are rebuilt from today. PUT /subscription-create-charge-now.
| Parameter | Type | Description |
|---|---|---|
| reset_schedule | boolean | Rebuild the rest of the schedule after this charge (default false). |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_create_charge_now",
"title": "Charge subscription now",
"description": "WRITE: CHARGES THE CUSTOMER'S PAYMENT METHOD IMMEDIATELY for the next billing attempt of the subscription and creates a Shopify order; it does not wait for the scheduled date. Only call it when the user clearly asked for an immediate charge. With reset_schedule=true the later attempts are rebuilt from today. PUT /subscription-create-charge-now.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"reset_schedule": {
"type": "boolean",
"description": "Rebuild the rest of the schedule after this charge (default false)."
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Charge subscription now",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: CHARGES THE CUSTOMER'S PAYMENT METHOD NOW for one specific billing attempt (for example a failed or upcoming one) and creates a Shopify order. Only call it when the user clearly asked for that charge. PUT /subscription-process-charge.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
| billing_attempt_id * | integer | Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription). |
{
"name": "sealsubscriptions_process_charge",
"title": "Process a specific charge",
"description": "WRITE: CHARGES THE CUSTOMER'S PAYMENT METHOD NOW for one specific billing attempt (for example a failed or upcoming one) and creates a Shopify order. Only call it when the user clearly asked for that charge. PUT /subscription-process-charge.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"billing_attempt_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
},
"billing_attempt_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Billing attempt id (billing_attempts[].id from sealsubscriptions_get_subscription).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Process a specific charge",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: Apply a Shopify discount code to an auto-charging subscription (not to recurring-invoice subscriptions); it lowers what the customer pays on the next charges. PUT /subscription-discount-code action=apply.
| Parameter | Type | Description |
|---|---|---|
| discount_code * | string | The discount code as the customer would type it. |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_apply_discount_code",
"title": "Apply discount code",
"description": "WRITE: Apply a Shopify discount code to an auto-charging subscription (not to recurring-invoice subscriptions); it lowers what the customer pays on the next charges. PUT /subscription-discount-code action=apply.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"discount_code"
],
"properties": {
"discount_code": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The discount code as the customer would type it."
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Apply discount code",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Remove a discount code from a subscription. Use the discount code id from the subscription's items[].discount_codes[].id (a uuid), not the code text. DELETE /subscription-discount-code.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
| discount_code_id * | string | Discount code id (a uuid) from sealsubscriptions_get_subscription → items[].discount_codes[].id. |
{
"name": "sealsubscriptions_remove_discount_code",
"title": "Remove discount code",
"description": "WRITE: Remove a discount code from a subscription. Use the discount code id from the subscription's items[].discount_codes[].id (a uuid), not the code text. DELETE /subscription-discount-code.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id",
"discount_code_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
},
"discount_code_id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Discount code id (a uuid) from sealsubscriptions_get_subscription → items[].discount_codes[].id."
}
}
},
"annotations": {
"title": "Remove discount code",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: SENDS AN EMAIL TO THE CUSTOMER of the subscription with a link to update their payment method (for example after failed charges). Only call it when the user clearly asked to contact the customer. PUT /subscription action=send_payment_method_update_email.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
{
"name": "sealsubscriptions_send_payment_method_update_email",
"title": "Email customer to update payment method",
"description": "WRITE: SENDS AN EMAIL TO THE CUSTOMER of the subscription with a link to update their payment method (for example after failed charges). Only call it when the user clearly asked to contact the customer. PUT /subscription action=send_payment_method_update_email.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Email customer to update payment method",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: Edit a subscription rule: its name, the plan selector label (`options`, e.g. "Deliver every") and the products it applies to. Cannot edit selling-plan pricing, billing intervals or automated interval-change rules; use the Seal app for those settings. product_variants REPLACES all products and variants linked to the rule: to add some without removing the others use sealsubscriptions_append_rule_product_variants. PUT /subscription-rule.
| Parameter | Type | Description |
|---|---|---|
| name | string | |
| options | string | Label for the plan selector, e.g. "Deliver every". |
| rule_id * | integer | Subscription rule id. |
| product_variants | array | The complete new list of products/variants (replaces the current list; an empty list unlinks every product). |
{
"name": "sealsubscriptions_edit_subscription_rule",
"title": "Edit subscription rule",
"description": "WRITE: Edit a subscription rule: its name, the plan selector label (`options`, e.g. \"Deliver every\") and the products it applies to. Cannot edit selling-plan pricing, billing intervals or automated interval-change rules; use the Seal app for those settings. product_variants REPLACES all products and variants linked to the rule: to add some without removing the others use sealsubscriptions_append_rule_product_variants. PUT /subscription-rule.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"rule_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"options": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Label for the plan selector, e.g. \"Deliver every\"."
},
"rule_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Subscription rule id.",
"exclusiveMinimum": 0
},
"product_variants": {
"type": "array",
"items": {
"type": "object",
"required": [
"product_id",
"variant_id"
],
"properties": {
"product_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,20}$"
},
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
],
"description": "Shopify product id."
},
"variant_id": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,20}$"
},
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
]
},
{
"type": "null"
}
],
"description": "Shopify variant id, or null for all variants of the product."
}
}
},
"maxItems": 500,
"description": "The complete new list of products/variants (replaces the current list; an empty list unlinks every product)."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Edit subscription rule",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: Add products or variants to a subscription rule without touching the ones already linked. PUT /subscription-rule/append-product-variants.
| Parameter | Type | Description |
|---|---|---|
| rule_id * | integer | Subscription rule id. |
| product_variants * | array | Products/variants to add. |
{
"name": "sealsubscriptions_append_rule_product_variants",
"title": "Add products to subscription rule",
"description": "WRITE: Add products or variants to a subscription rule without touching the ones already linked. PUT /subscription-rule/append-product-variants.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"rule_id",
"product_variants"
],
"properties": {
"rule_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Subscription rule id.",
"exclusiveMinimum": 0
},
"product_variants": {
"type": "array",
"items": {
"type": "object",
"required": [
"product_id",
"variant_id"
],
"properties": {
"product_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,20}$"
},
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
],
"description": "Shopify product id."
},
"variant_id": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,20}$"
},
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
]
},
{
"type": "null"
}
],
"description": "Shopify variant id, or null for all variants of the product."
}
}
},
"maxItems": 500,
"minItems": 1,
"description": "Products/variants to add."
}
}
},
"annotations": {
"title": "Add products to subscription rule",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Tools for Seal Subscriptions, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which subscriptions are scheduled to be charged tomorrow?"; "Show the subscriptions of john@example.com and their next billing dates."; "Skip the next billing attempt of subscription 568185.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Seal Subscriptions data. Free plan: 50 tool calls per month. Run sealsubscriptions_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run sealsubscriptions_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run sealsubscriptions_upgrade without a plan: it returns both plans, each with a payment link for the user to open. sealsubscriptions_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| s_country_code | string |
| note_attributes | array | Replaces all note attributes. |
| s_province_code | string |
| subscription_id * | integer | The subscription's `id` (not its `internal_id`). |
| billing_interval | string | Billing interval, e.g. "8 week". Longer than delivery_interval = prepaid. |
| delivery_interval | string | Delivery interval, e.g. "4 week" or "1 month". |
| billing_max_cycles | integer | Maximum number of payments (0 = unlimited). |
| billing_min_cycles | integer | Minimum number of payments. |
| delivery_method_code | string |
| delivery_method_title | string |
| delivery_method_presentment_title | string |
| automatically_update_product_prices | boolean | When switching between prepaid and not prepaid, reprice the items. |
{
"name": "sealsubscriptions_edit_subscription",
"title": "Edit subscription",
"description": "WRITE: Edit a subscription's schedule and details: delivery and billing interval (a billing interval longer than the delivery interval makes it prepaid), min/max number of payments, note attributes (an empty list removes them), delivery method and price, and the shipping address. Only the fields you pass change. To change items use the item tools. PUT /subscription action=edit.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"s_zip": {
"type": "string",
"maxLength": 40
},
"s_city": {
"type": "string",
"maxLength": 200
},
"s_phone": {
"type": "string",
"maxLength": 60
},
"s_company": {
"type": "string",
"maxLength": 200
},
"s_country": {
"type": "string",
"maxLength": 200
},
"s_address1": {
"type": "string",
"maxLength": 300
},
"s_address2": {
"type": "string",
"maxLength": 300
},
"s_province": {
"type": "string",
"maxLength": 200
},
"s_last_name": {
"type": "string",
"maxLength": 200
},
"s_first_name": {
"type": "string",
"maxLength": 200
},
"delivery_price": {
"type": "number",
"minimum": 0
},
"s_country_code": {
"type": "string",
"maxLength": 10
},
"note_attributes": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"maxLength": 2000
}
}
},
"maxItems": 50,
"description": "Replaces all note attributes."
},
"s_province_code": {
"type": "string",
"maxLength": 20
},
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The subscription's `id` (not its `internal_id`).",
"exclusiveMinimum": 0
},
"billing_interval": {
"type": "string",
"maxLength": 30,
"minLength": 3,
"description": "Billing interval, e.g. \"8 week\". Longer than delivery_interval = prepaid."
},
"delivery_interval": {
"type": "string",
"maxLength": 30,
"minLength": 3,
"description": "Delivery interval, e.g. \"4 week\" or \"1 month\"."
},
"billing_max_cycles": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "Maximum number of payments (0 = unlimited)."
},
"billing_min_cycles": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "Minimum number of payments."
},
"delivery_method_code": {
"type": "string",
"maxLength": 200
},
"delivery_method_title": {
"type": "string",
"maxLength": 200
},
"delivery_method_presentment_title": {
"type": "string",
"maxLength": 200
},
"automatically_update_product_prices": {
"type": "boolean",
"description": "When switching between prepaid and not prepaid, reprice the items."
}
}
},
"annotations": {
"title": "Edit subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}