awtomic_cancel_customer_subscription

WRITE: cancel one shopper's subscription contract in Awtomic. Billing and shipping stop; a cancelled non-prepaid subscription can be brought back with awtomic_reactivate_subscription. This cancels the shop's customer subscription, not your usefulapi plan. Awtomic runs the shop's own automations for this event, so the customer may get an email or SMS and webhooks may fire. Awtomic cancels it on its side even if Shopify rejects the cancel. Only use it when the user explicitly asks to cancel this subscription, and confirm_cancel must be true. A cancelled prepaid subscription cannot be reactivated. POST /customers/{customerId}/subscriptions/{subscriptionId}/cancel.

destructive

Argument	Type	Description
reason	string	Short reason code for Awtomic's analytics, e.g. too_expensive.
details	string	Free-text details of why the subscription is cancelled.
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
confirm_cancel*	boolean	Must be true: you confirm the user asked to cancel this shopper's subscription.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id",
    "confirm_cancel"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Short reason code for Awtomic's analytics, e.g. too_expensive."
    },
    "details": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "Free-text details of why the subscription is cancelled."
    },
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "confirm_cancel": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: you confirm the user asked to cancel this shopper's subscription."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_get_customer

A customer: name, email, phone, orders count, amount spent, customer-since date, Awtomic overrides and the ids of their subscription contracts. GET /customers/{customerId}.

read-only

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    }
  }
}

awtomic_get_customer_addresses

A customer's saved addresses and which one is the default. GET /customers/{customerId}/address.

read-only

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    }
  }
}

awtomic_get_customer_payment_methods

A customer's payment methods on file: type (card, Shop Pay, PayPal), card brand, last digits, expiry and whether it was revoked. Never the full card number. Use it to spot expired cards before a renewal. GET /customers/{customerId}/payment-methods.

read-only

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    }
  }
}

awtomic_get_origin_order

The Shopify order that started a subscription (id, name, creation date). GET /customers/{customerId}/subscriptions/{subscriptionId}/origin-order.

read-only

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_get_origin_order_fulfillments

Fulfillment status and the fulfillment orders (status, fulfill-at date) of a subscription's origin order. GET /customers/{customerId}/subscriptions/{subscriptionId}/origin-order/fulfillments.

read-only

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_get_selling_plan_group

One selling plan group with its selling plans (name, prepaid orders, gift support) and the products it applies to. GET /shops/selling-plan-groups/{sellingPlanGroupId}.

read-only

Argument	Type	Description
selling_plan_group_id*	string	Selling plan group id (gId or numeric id) from awtomic_list_selling_plan_groups.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "selling_plan_group_id"
  ],
  "properties": {
    "selling_plan_group_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Selling plan group id (gId or numeric id) from awtomic_list_selling_plan_groups."
    }
  }
}

awtomic_get_subscription

One subscription contract with its lines (products, quantities, prices). Needs the customer id and the subscription id. GET /customers/{customerId}/subscriptions/{subscriptionId}.

read-only

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_get_successful_billing_count

How many billing attempts of a subscription succeeded, including those made before a migration from another subscription app. GET /subscriptions/{subscriptionId}/total-successful-billing-count.

read-only

Argument	Type	Description
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_list_billing_attempts

A subscription's billing attempts: status (SUCCESS or FAILURE), error code and message, amount, currency and dates. Use it to see why a renewal failed. GET /customers/{customerId}/subscriptions/{subscriptionId}/billing-attempts.

read-only

Argument	Type	Description
limit	integer	Items per page, 1-100 (default 20).
cursor	string	Paging cursor: the next_cursor of the previous reply. Omit for the first page.
reverse	boolean	Read in reverse order (newest first or oldest first, as Awtomic defines it).
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Items per page, 1-100 (default 20).",
      "exclusiveMinimum": 0
    },
    "cursor": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "Paging cursor: the next_cursor of the previous reply. Omit for the first page."
    },
    "reverse": {
      "type": "boolean",
      "description": "Read in reverse order (newest first or oldest first, as Awtomic defines it)."
    },
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_list_customer_subscriptions

List one customer's subscriptions (id, status, next billing date). Set expand_lines to include each subscription's lines; that makes the reply much larger. GET /customers/{customerId}/subscriptions.

read-only

Argument	Type	Description
limit	integer	Items per page, 1-100 (default 100).
cursor	string	Paging cursor: the next_cursor of the previous reply. Omit for the first page.
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
expand_lines	boolean	Include the subscription lines (larger reply). Default false.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Items per page, 1-100 (default 100).",
      "exclusiveMinimum": 0
    },
    "cursor": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "Paging cursor: the next_cursor of the previous reply. Omit for the first page."
    },
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "expand_lines": {
      "type": "boolean",
      "description": "Include the subscription lines (larger reply). Default false."
    }
  }
}

awtomic_list_selling_plan_groups

The shop's selling plan groups (subscription plans): name, summary, options, position and whether it is a prepaid plan. Use the ids with awtomic_get_selling_plan_group. GET /shops/selling-plan-groups.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

awtomic_list_subscriptions

List the shop's subscription contracts (id, status, next billing date and more), 100 per page by default. Use reverse to read the newest first. Pass next_cursor back as cursor for the next page. GET /subscriptions.

read-only

Argument	Type	Description
limit	integer	Items per page, 1-100 (default 100).
cursor	string	Paging cursor: the next_cursor of the previous reply. Omit for the first page.
reverse	boolean	Read in reverse order.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Items per page, 1-100 (default 100).",
      "exclusiveMinimum": 0
    },
    "cursor": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "Paging cursor: the next_cursor of the previous reply. Omit for the first page."
    },
    "reverse": {
      "type": "boolean",
      "description": "Read in reverse order."
    }
  }
}

awtomic_order_now

WRITE: bill the customer's saved payment method and create the subscription's next order immediately, instead of waiting for the billing date. THIS CHARGES THE CUSTOMER. Awtomic refuses (409 ORDER_RECENTLY_PLACED) if the latest billing attempt is pending or succeeded under 10 minutes ago. Set manual_retry only to retry a failed billing attempt. Only use it when the user explicitly asks to place this order now, and confirm_charge must be true. Awtomic runs the shop's own automations for this event, so the customer may get an email or SMS and webhooks may fire. POST /customers/{customerId}/subscriptions/{subscriptionId}/order-now.

destructive

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
manual_retry	boolean	Retry a failed billing attempt.
confirm_charge*	boolean	Must be true: you confirm the customer is charged now.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id",
    "confirm_charge"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "manual_retry": {
      "type": "boolean",
      "description": "Retry a failed billing attempt."
    },
    "confirm_charge": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: you confirm the customer is charged now."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_pause_subscription

WRITE: pause a subscription so it is not billed or shipped until it is reactivated (awtomic_reactivate_subscription). A subscription in dunning is taken out of dunning. Awtomic runs the shop's own automations for this event, so the customer may get an email or SMS and webhooks may fire. Awtomic pauses it on its side even if Shopify rejects the pause. POST /customers/{customerId}/subscriptions/{subscriptionId}/pause.

destructive

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_reactivate_subscription

WRITE: reactivate a paused or cancelled subscription, so billing resumes. A cancelled prepaid subscription cannot be reactivated. Without next_billing_date Awtomic works it out from the subscription's interval; the customer is charged on that date. Awtomic runs the shop's own automations for this event, so the customer may get an email or SMS and webhooks may fire. POST /customers/{customerId}/subscriptions/{subscriptionId}/reactivate.

destructive

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.
next_billing_date	string	A date yyyy-mm-dd (read in the shop's time zone, shop renewal billing time applies) or an ISO 8601 date-time with a timezone. Must be later than the end of today.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    },
    "next_billing_date": {
      "type": "string",
      "description": "A date yyyy-mm-dd (read in the shop's time zone, shop renewal billing time applies) or an ISO 8601 date-time with a timezone. Must be later than the end of today."
    }
  }
}

awtomic_send_payment_update_email

WRITE: make Shopify email the customer a link to update their payment method for this subscription. This SENDS AN EMAIL TO THE CUSTOMER each time it is called. Use it for failed payments or expired cards, only when the user asks, and confirm_send must be true. POST /customers/{customerId}/subscriptions/{subscriptionId}/send-customer-payment-email.

destructive

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
confirm_send*	boolean	Must be true: you confirm the user asked to email this customer now.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id",
    "confirm_send"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "confirm_send": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: you confirm the user asked to email this customer now."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_set_next_billing_date

WRITE: change when a subscription is next billed. The date must be later than the end of today. A paused subscription is reactivated by this call, and one in dunning is taken out of dunning. The customer is charged on the new date. POST /customers/{customerId}/subscriptions/{subscriptionId}/next-billing-date.

destructive

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.
next_billing_date*	string	A date yyyy-mm-dd (read in the shop's time zone, shop renewal billing time applies) or an ISO 8601 date-time with a timezone. Must be later than the end of today.

Input schema (JSON)

{
  "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": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    },
    "next_billing_date": {
      "type": "string",
      "description": "A date yyyy-mm-dd (read in the shop's time zone, shop renewal billing time applies) or an ISO 8601 date-time with a timezone. Must be later than the end of today."
    }
  }
}

awtomic_skip_next_order

WRITE: skip a subscription's next order. The subscription must be active; Awtomic moves the next billing date by one interval (each call skips one more order, so do not repeat it). The reply has skipEventId: pass it to awtomic_undo_skip to undo. Awtomic runs the shop's own automations for this event, so the customer may get an email or SMS and webhooks may fire. POST /customers/{customerId}/subscriptions/{subscriptionId}/skip.

destructive

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_undo_skip

WRITE: undo a skipped order, restoring the billing date from before the skip. Needs the skipEventId returned by awtomic_skip_next_order; Awtomic refuses (409) when the skip can no longer be undone. POST /customers/{customerId}/subscriptions/{subscriptionId}/next-billing-date with eventType UNDO_SKIP.

destructive

Argument	Type	Description
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
skip_event_id*	string	The skipEventId from awtomic_skip_next_order.
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id",
    "skip_event_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "skip_event_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The skipEventId from awtomic_skip_next_order."
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

awtomic_update_frequency

WRITE: change how often a subscription is billed and delivered, for example every 2 WEEK or every 1 MONTH. Changes every future order of that subscription. POST /customers/{customerId}/subscriptions/{subscriptionId}/frequency.

destructive

Argument	Type	Description
interval*	string	Interval unit.
customer_id*	string	Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too.
interval_count*	integer	Number of interval units between orders (2 + WEEK = every 2 weeks).
subscription_id*	string	Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "subscription_id",
    "interval",
    "interval_count"
  ],
  "properties": {
    "interval": {
      "enum": [
        "DAY",
        "WEEK",
        "MONTH",
        "YEAR"
      ],
      "type": "string",
      "description": "Interval unit."
    },
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify customer id (the number in the Shopify admin customer URL, e.g. 6012345678901). A gid://shopify/Customer/… id is accepted too."
    },
    "interval_count": {
      "type": "integer",
      "maximum": 366,
      "description": "Number of interval units between orders (2 + WEEK = every 2 weeks).",
      "exclusiveMinimum": 0
    },
    "subscription_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Shopify subscription contract id (the SubscriptionId of a subscription, e.g. 1234567890). A gid://shopify/SubscriptionContract/… id is accepted too."
    }
  }
}

Awtomic MCP by usefulapi

Try it

awtomic_cancel_customer_subscription Destructive

Awtomic MCP by usefulapi

Try it

awtomic_cancel_customer_subscription Destructive

Tools (21)