Smartrr MCP by usefulapi is an MCP server published by io.usefulapi, hosted at smartrr.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 21 tools, including smartrr_list_subscriptions, smartrr_get_subscription, smartrr_list_customer_subscriptions, smartrr_get_subscription_events, smartrr_get_subscription_orders.
Manage Smartrr subscriptions on Shopify: customers, orders, bills; pause, resume, cancel.
4,161 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 customer subscriptions (Smartrr 'purchase states') with status, next billing date, selling plan, line items, shipping address, discounts and the customer (id, email, name). Filter by status, next billing date or creation date. The ids you need for the other tools: `id` (subscription id), `custRel.id` (customer id) and `shopifyId` (Shopify subscription id). GET /vendor/purchase-state.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| sort | string | Sort by creation date (default: Smartrr's own order). |
| status | string | Only subscriptions in this status. |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_after | string | Only subscriptions created on or after this date. |
| created_before | string | Only subscriptions created on or before this date. |
| next_billing_after | string | Only subscriptions whose next billing date is on or after this date. |
| next_billing_before | string | Only subscriptions whose next billing date is on or before this date. |
{
"name": "smartrr_list_subscriptions",
"title": "List subscriptions",
"description": "List customer subscriptions (Smartrr 'purchase states') with status, next billing date, selling plan, line items, shipping address, discounts and the customer (id, email, name). Filter by status, next billing date or creation date. The ids you need for the other tools: `id` (subscription id), `custRel.id` (customer id) and `shopifyId` (Shopify subscription id). GET /vendor/purchase-state.",
"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). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"description": "Sort by creation date (default: Smartrr's own order)."
},
"status": {
"enum": [
"ACTIVE",
"PAUSED",
"CANCELLED",
"EXPIRED",
"FAILED"
],
"type": "string",
"description": "Only subscriptions in this status."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_after": {
"type": "string",
"description": "Only subscriptions created on or after this date."
},
"created_before": {
"type": "string",
"description": "Only subscriptions created on or before this date."
},
"next_billing_after": {
"type": "string",
"description": "Only subscriptions whose next billing date is on or after this date."
},
"next_billing_before": {
"type": "string",
"description": "Only subscriptions whose next billing date is on or before this date."
}
}
},
"annotations": {
"title": "List subscriptions",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One subscription by its Shopify subscription id (the `shopifyId` field from smartrr_list_subscriptions, passed exactly as shown): status, schedule, next billing date, line items, discounts, shipping address, customer and payment method (brand, last digits and expiry only). GET /vendor/purchase-state/{shopifySubscriptionId}.
| Parameter | Type | Description |
|---|---|---|
| shopify_subscription_id * | string | The subscription's Shopify id (`shopifyId` in smartrr_list_subscriptions). |
{
"name": "smartrr_get_subscription",
"title": "Get subscription",
"description": "One subscription by its Shopify subscription id (the `shopifyId` field from smartrr_list_subscriptions, passed exactly as shown): status, schedule, next billing date, line items, discounts, shipping address, customer and payment method (brand, last digits and expiry only). GET /vendor/purchase-state/{shopifySubscriptionId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"shopify_subscription_id"
],
"properties": {
"shopify_subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The subscription's Shopify id (`shopifyId` in smartrr_list_subscriptions)."
}
}
},
"annotations": {
"title": "Get subscription",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the subscriptions of one customer, by Smartrr customer id (`custRel.id` from smartrr_list_subscriptions, or `id` from smartrr_list_customers). GET /vendor/customer/{customerRelationshipId}/purchase-state/.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| status | string | Only subscriptions in this status. |
| page_size | integer | Results per page, 1-100 (default 25). |
| customer_id * | string | Smartrr customer id. |
{
"name": "smartrr_list_customer_subscriptions",
"title": "List a customer's subscriptions",
"description": "List the subscriptions of one customer, by Smartrr customer id (`custRel.id` from smartrr_list_subscriptions, or `id` from smartrr_list_customers). GET /vendor/customer/{customerRelationshipId}/purchase-state/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"status": {
"enum": [
"ACTIVE",
"PAUSED",
"CANCELLED",
"EXPIRED",
"FAILED"
],
"type": "string",
"description": "Only subscriptions in this status."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"customer_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr customer id."
}
}
},
"annotations": {
"title": "List a customer's subscriptions",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The 250 most recent events on a subscription (pause, skip, cancel, activate, billing attempts and failures, line-item and address changes, discounts) with who did it. GET /vendor/purchase-state/{shopifySubscriptionId}/events.
| Parameter | Type | Description |
|---|---|---|
| shopify_subscription_id * | string | The subscription's Shopify id (`shopifyId` in smartrr_list_subscriptions). |
{
"name": "smartrr_get_subscription_events",
"title": "Get subscription history",
"description": "The 250 most recent events on a subscription (pause, skip, cancel, activate, billing attempts and failures, line-item and address changes, discounts) with who did it. GET /vendor/purchase-state/{shopifySubscriptionId}/events.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"shopify_subscription_id"
],
"properties": {
"shopify_subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The subscription's Shopify id (`shopifyId` in smartrr_list_subscriptions)."
}
}
},
"annotations": {
"title": "Get subscription history",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Orders generated by one subscription, by its Shopify subscription id. GET /vendor/purchase-state/{shopifySubscriptionId}/orders.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| sort | string | Sort by creation date (default: Smartrr's own order). |
| page_size | integer | Results per page, 1-100 (default 25). |
| shopify_subscription_id * | string | The subscription's Shopify id (`shopifyId` in smartrr_list_subscriptions). |
{
"name": "smartrr_get_subscription_orders",
"title": "List a subscription's orders",
"description": "Orders generated by one subscription, by its Shopify subscription id. GET /vendor/purchase-state/{shopifySubscriptionId}/orders.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"shopify_subscription_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"description": "Sort by creation date (default: Smartrr's own order)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"shopify_subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The subscription's Shopify id (`shopifyId` in smartrr_list_subscriptions)."
}
}
},
"annotations": {
"title": "List a subscription's orders",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Billing attempts of one subscription (amount, status pending/processing/succeeded/failed/canceled, billing date, retry count, error), by its Shopify subscription id. GET /vendor/purchase-state/{shopifySubscriptionId}/bills.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| sort | string | Sort by creation date (default: Smartrr's own order). |
| page_size | integer | Results per page, 1-100 (default 25). |
| shopify_subscription_id * | string | The subscription's Shopify id (`shopifyId` in smartrr_list_subscriptions). |
{
"name": "smartrr_get_subscription_bills",
"title": "List a subscription's bills",
"description": "Billing attempts of one subscription (amount, status pending/processing/succeeded/failed/canceled, billing date, retry count, error), by its Shopify subscription id. GET /vendor/purchase-state/{shopifySubscriptionId}/bills.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"shopify_subscription_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"description": "Sort by creation date (default: Smartrr's own order)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"shopify_subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The subscription's Shopify id (`shopifyId` in smartrr_list_subscriptions)."
}
}
},
"annotations": {
"title": "List a subscription's bills",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List Smartrr customers (subscribers) with email, name, phone, order count, total spent and custom attributes. Search by email fragment or filter by Shopify customer id. GET /vendor/customer-relationship.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| sort | string | Sort by creation date (default: Smartrr's own order). |
| string | Customers whose email contains this text. | |
| page_size | integer | Results per page, 1-100 (default 25). |
| shopify_customer_id | string | Only the customer with this Shopify customer id. |
{
"name": "smartrr_list_customers",
"title": "List customers",
"description": "List Smartrr customers (subscribers) with email, name, phone, order count, total spent and custom attributes. Search by email fragment or filter by Shopify customer id. GET /vendor/customer-relationship.",
"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). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"description": "Sort by creation date (default: Smartrr's own order)."
},
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Customers whose email contains this text."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"shopify_customer_id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Only the customer with this Shopify customer id."
}
}
},
"annotations": {
"title": "List customers",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List orders Smartrr has synced from Shopify (subscription and one-time) with totals, status, financial and fulfillment status, tracking, items and customer. Filter by processed date or order label (e.g. #1001). GET /vendor/order.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| sort | string | Sort by creation date (default: Smartrr's own order). |
| page_size | integer | Results per page, 1-100 (default 25). |
| order_label | string | Orders whose Shopify order label contains this text, e.g. #1001. |
| processed_after | string | Only orders processed on or after this date. |
| processed_before | string | Only orders processed on or before this date. |
{
"name": "smartrr_list_orders",
"title": "List orders",
"description": "List orders Smartrr has synced from Shopify (subscription and one-time) with totals, status, financial and fulfillment status, tracking, items and customer. Filter by processed date or order label (e.g. #1001). GET /vendor/order.",
"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). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"description": "Sort by creation date (default: Smartrr's own order)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"order_label": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Orders whose Shopify order label contains this text, e.g. #1001."
},
"processed_after": {
"type": "string",
"description": "Only orders processed on or after this date."
},
"processed_before": {
"type": "string",
"description": "Only orders processed on or before this date."
}
}
},
"annotations": {
"title": "List orders",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One order by its Shopify order id (the `shopifyId` field in smartrr_list_orders, passed as shown). GET /vendor/orders/{shopifyId}.
| Parameter | Type | Description |
|---|---|---|
| shopify_order_id * | string | The order's Shopify id (`shopifyId` in smartrr_list_orders). |
{
"name": "smartrr_get_order",
"title": "Get order",
"description": "One order by its Shopify order id (the `shopifyId` field in smartrr_list_orders, passed as shown). GET /vendor/orders/{shopifyId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"shopify_order_id"
],
"properties": {
"shopify_order_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The order's Shopify id (`shopifyId` in smartrr_list_orders)."
}
}
},
"annotations": {
"title": "Get order",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List billing attempts across all subscriptions with amount, status (pending, processing, succeeded, failed, canceled), billing date, retry count, error and the subscription and customer. Filter by billing date; `status` filters the returned page only (use page_size 100 and next_page to cover more). Bill ids are numbers. GET /vendor/bill.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| sort | string | Sort by creation date (default: Smartrr's own order). |
| status | string | Keep only bills in this status (applied to the fetched page, not server-side). |
| page_size | integer | Results per page, 1-100 (default 25). |
| billing_after | string | Only bills with a billing date on or after this date. |
| billing_before | string | Only bills with a billing date on or before this date. |
{
"name": "smartrr_list_bills",
"title": "List bills",
"description": "List billing attempts across all subscriptions with amount, status (pending, processing, succeeded, failed, canceled), billing date, retry count, error and the subscription and customer. Filter by billing date; `status` filters the returned page only (use page_size 100 and next_page to cover more). Bill ids are numbers. GET /vendor/bill.",
"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). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"description": "Sort by creation date (default: Smartrr's own order)."
},
"status": {
"enum": [
"pending",
"processing",
"succeeded",
"failed",
"canceled"
],
"type": "string",
"description": "Keep only bills in this status (applied to the fetched page, not server-side)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"billing_after": {
"type": "string",
"description": "Only bills with a billing date on or after this date."
},
"billing_before": {
"type": "string",
"description": "Only bills with a billing date on or before this date."
}
}
},
"annotations": {
"title": "List bills",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The audit trail of one bill: every status change, retry and error. GET /vendor/bill/{billId}/history.
| Parameter | Type | Description |
|---|---|---|
| bill_id * | integer | Smartrr bill id (numeric `id` in smartrr_list_bills). |
{
"name": "smartrr_get_bill_history",
"title": "Get bill history",
"description": "The audit trail of one bill: every status change, retry and error. GET /vendor/bill/{billId}/history.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bill_id"
],
"properties": {
"bill_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Smartrr bill id (numeric `id` in smartrr_list_bills).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get bill history",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The store's subscription programs (selling plan groups) and their plans: name, options, delivery and billing frequency, discounts. GET /vendor/selling-plan-group.
No parameters.
{
"name": "smartrr_list_selling_plan_groups",
"title": "List subscription programs",
"description": "The store's subscription programs (selling plan groups) and their plans: name, options, delivery and billing frequency, discounts. GET /vendor/selling-plan-group.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List subscription programs",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The cancellation reasons configured in Smartrr (id, type, text, action, retention discount). Use an `id` as reason_id when cancelling a subscription. GET /vendor/cancellation-reasons.
No parameters.
{
"name": "smartrr_list_cancellation_reasons",
"title": "List cancellation reasons",
"description": "The cancellation reasons configured in Smartrr (id, type, text, action, retention discount). Use an `id` as reason_id when cancelling a subscription. GET /vendor/cancellation-reasons.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List cancellation reasons",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Active subscription count and active subscriber count for each day in a date range. GET /vendor/analytics-simple.
| Parameter | Type | Description |
|---|---|---|
| end_date * | string | Last day of the range. |
| start_date * | string | First day of the range. |
{
"name": "smartrr_get_analytics",
"title": "Get subscription analytics",
"description": "Active subscription count and active subscriber count for each day in a date range. GET /vendor/analytics-simple.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"end_date": {
"type": "string",
"description": "Last day of the range."
},
"start_date": {
"type": "string",
"description": "First day of the range."
}
}
},
"annotations": {
"title": "Get subscription analytics",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: pause a customer's subscription until a date: no orders or charges are created while it is paused, then it resumes on that date. Reverse it with smartrr_resume_subscription. Takes the customer id and subscription id from smartrr_list_subscriptions. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/pause.
| Parameter | Type | Description |
|---|---|---|
| customer_id * | string | Smartrr customer id (`custRel.id`). |
| unpause_date * | string | When the subscription resumes. |
| subscription_id * | string | Smartrr subscription id (`id`, a UUID). |
{
"name": "smartrr_pause_subscription",
"title": "Pause a subscription",
"description": "WRITE: pause a customer's subscription until a date: no orders or charges are created while it is paused, then it resumes on that date. Reverse it with smartrr_resume_subscription. Takes the customer id and subscription id from smartrr_list_subscriptions. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/pause.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"subscription_id",
"unpause_date"
],
"properties": {
"customer_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr customer id (`custRel.id`)."
},
"unpause_date": {
"type": "string",
"description": "When the subscription resumes."
},
"subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr subscription id (`id`, a UUID)."
}
}
},
"annotations": {
"title": "Pause a subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}WRITE: reactivate a paused or cancelled subscription; the customer will be billed on next_billing_date and every cycle after. Customer-facing: it restarts charges to the customer's card. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/activate.
| Parameter | Type | Description |
|---|---|---|
| customer_id * | string | Smartrr customer id (`custRel.id`). |
| subscription_id * | string | Smartrr subscription id (`id`, a UUID). |
| next_billing_date * | string | The next billing date after reactivation. |
{
"name": "smartrr_resume_subscription",
"title": "Resume a subscription",
"description": "WRITE: reactivate a paused or cancelled subscription; the customer will be billed on next_billing_date and every cycle after. Customer-facing: it restarts charges to the customer's card. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/activate.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"subscription_id",
"next_billing_date"
],
"properties": {
"customer_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr customer id (`custRel.id`)."
},
"subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr subscription id (`id`, a UUID)."
},
"next_billing_date": {
"type": "string",
"description": "The next billing date after reactivation."
}
}
},
"annotations": {
"title": "Resume a subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}WRITE, DESTRUCTIVE: cancel a customer's subscription in the merchant's store (this is the customer's Smartrr subscription, not your usefulapi plan). It stops all future orders and charges; the reason may trigger Smartrr's configured cancellation emails or actions. It can be undone only with smartrr_resume_subscription. Get reason_id from smartrr_list_cancellation_reasons. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/cancel.
| Parameter | Type | Description |
|---|---|---|
| reason_id * | string | Cancellation reason id from smartrr_list_cancellation_reasons. |
| customer_id * | string | Smartrr customer id (`custRel.id`). |
| subscription_id * | string | Smartrr subscription id (`id`, a UUID). |
{
"name": "smartrr_cancel_customer_subscription",
"title": "Cancel a customer's subscription",
"description": "WRITE, DESTRUCTIVE: cancel a customer's subscription in the merchant's store (this is the customer's Smartrr subscription, not your usefulapi plan). It stops all future orders and charges; the reason may trigger Smartrr's configured cancellation emails or actions. It can be undone only with smartrr_resume_subscription. Get reason_id from smartrr_list_cancellation_reasons. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/cancel.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"subscription_id",
"reason_id"
],
"properties": {
"reason_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Cancellation reason id from smartrr_list_cancellation_reasons."
},
"customer_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr customer id (`custRel.id`)."
},
"subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr subscription id (`id`, a UUID)."
}
}
},
"annotations": {
"title": "Cancel a customer's subscription",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: skip one scheduled order of a subscription (no order and no charge for that cycle; the schedule moves on). `date` is the scheduled order date to skip; omit it to skip the next one. Reverse with smartrr_unskip_order. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/skip.
| Parameter | Type | Description |
|---|---|---|
| date | string | The scheduled order date to skip (default: the next order). |
| customer_id * | string | Smartrr customer id (`custRel.id`). |
| subscription_id * | string | Smartrr subscription id (`id`, a UUID). |
{
"name": "smartrr_skip_order",
"title": "Skip a subscription order",
"description": "WRITE: skip one scheduled order of a subscription (no order and no charge for that cycle; the schedule moves on). `date` is the scheduled order date to skip; omit it to skip the next one. Reverse with smartrr_unskip_order. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/skip.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"subscription_id"
],
"properties": {
"date": {
"type": "string",
"description": "The scheduled order date to skip (default: the next order)."
},
"customer_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr customer id (`custRel.id`)."
},
"subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr subscription id (`id`, a UUID)."
}
}
},
"annotations": {
"title": "Skip a subscription order",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}WRITE: restore a previously skipped order of a subscription, so it is billed and shipped again. `date` is the skipped order date; omit it to restore the earliest skip. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/unskip.
| Parameter | Type | Description |
|---|---|---|
| date | string | The skipped order date to restore (default: the earliest skipped one). |
| customer_id * | string | Smartrr customer id (`custRel.id`). |
| subscription_id * | string | Smartrr subscription id (`id`, a UUID). |
{
"name": "smartrr_unskip_order",
"title": "Unskip a subscription order",
"description": "WRITE: restore a previously skipped order of a subscription, so it is billed and shipped again. `date` is the skipped order date; omit it to restore the earliest skip. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/unskip.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"subscription_id"
],
"properties": {
"date": {
"type": "string",
"description": "The skipped order date to restore (default: the earliest skipped one)."
},
"customer_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr customer id (`custRel.id`)."
},
"subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr subscription id (`id`, a UUID)."
}
}
},
"annotations": {
"title": "Unskip a subscription order",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}WRITE: change the date on which a subscription is next billed and its order created. Customer-facing: the customer is charged on the new date. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/next-billing-date.
| Parameter | Type | Description |
|---|---|---|
| date * | string | The new next billing date. |
| customer_id * | string | Smartrr customer id (`custRel.id`). |
| subscription_id * | string | Smartrr subscription id (`id`, a UUID). |
{
"name": "smartrr_set_next_billing_date",
"title": "Set next billing date",
"description": "WRITE: change the date on which a subscription is next billed and its order created. Customer-facing: the customer is charged on the new date. PUT /vendor/customer/{customerId}/purchase-state/{subscriptionId}/next-billing-date.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"subscription_id",
"date"
],
"properties": {
"date": {
"type": "string",
"description": "The new next billing date."
},
"customer_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr customer id (`custRel.id`)."
},
"subscription_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Smartrr subscription id (`id`, a UUID)."
}
}
},
"annotations": {
"title": "Set next billing date",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}WRITE, CHARGES THE CUSTOMER: retry a billing attempt now. If it succeeds the customer's saved payment method is charged for the bill amount and the order is created. Check the bill with smartrr_list_bills first; do not retry a succeeded bill. Not idempotent: each call can charge again. Requires confirm=true. POST /vendor/bill/{billId}/retry.
| Parameter | Type | Description |
|---|---|---|
| bill_id * | integer | Smartrr bill id (numeric `id` in smartrr_list_bills). |
| confirm * | boolean | Must be true: confirms the customer's saved payment method should be charged now. |
{
"name": "smartrr_retry_bill",
"title": "Retry a failed bill",
"description": "WRITE, CHARGES THE CUSTOMER: retry a billing attempt now. If it succeeds the customer's saved payment method is charged for the bill amount and the order is created. Check the bill with smartrr_list_bills first; do not retry a succeeded bill. Not idempotent: each call can charge again. Requires confirm=true. POST /vendor/bill/{billId}/retry.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bill_id",
"confirm"
],
"properties": {
"bill_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Smartrr bill id (numeric `id` in smartrr_list_bills).",
"exclusiveMinimum": 0
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: confirms the customer's saved payment method should be charged now."
}
}
},
"annotations": {
"title": "Retry a failed bill",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Tools for Smartrr, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which subscriptions have a failed bill this week?"; "Show every active subscription that renews in the next 7 days."; "Pause the subscription of jane@example.com until January 15.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Smartrr data. Free plan: 50 tool calls per month. Run smartrr_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 smartrr_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 smartrr_upgrade without a plan: it returns both plans, each with a payment link for the user to open. smartrr_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.