Appstle Subscriptions

Appstle Subscriptions

This connector uses the Appstle Subscriptions Admin API (https://subscription-admin.appstle.com/api/external/v2) of Appstle, the subscription app for Shopify stores. It reads subscription contracts, customers, upcoming and past renewal orders (billing attempts), subscription groups and selling plans, product swap rules, retention activity and per-contract revenue, and it can manage subscriptions: pause, resume, cancel, skip or reschedule orders, change frequency and next billing date, add, swap or remove products, apply or remove discounts, and change the delivery address.

Setup (2 minutes)

1. In the Shopify admin open the Appstle Subscriptions app, then Settings, API Key Management (API access needs an Appstle plan that includes it).
2. Create an API key (up to 10 per store) and paste it into APPSTLE_API_KEY. It is sent in the X-API-Key header and gives full access to the store's subscriptions: keep it secret.
3. Run appstle_subscriptions_list_subscription_contracts to check the key.

Workflow

• Find a subscription: appstle_subscriptions_list_subscription_contracts (by status, customer name or email, order number, product, next billing date), or appstle_subscriptions_list_customers then appstle_subscriptions_get_customer, appstle_subscriptions_list_customer_subscriptions. appstle_subscriptions_get_contract gives the full contract with line ids and discount ids.
• Orders: appstle_subscriptions_list_upcoming_orders gives the billing attempt ids of the next orders; appstle_subscriptions_list_past_orders the processed renewals; appstle_subscriptions_get_contract_fulfillments tracking of the latest order.
• Skips and dates: appstle_subscriptions_skip_order, appstle_subscriptions_skip_upcoming_order, appstle_subscriptions_unskip_order, appstle_subscriptions_reschedule_order, appstle_subscriptions_update_next_billing_date; appstle_subscriptions_bill_order_now charges an order at once.
• Pause and cancel: appstle_subscriptions_update_contract_status pauses (PAUSED) or resumes (ACTIVE); appstle_subscriptions_cancel_contract cancels for good.
• Frequency: appstle_subscriptions_update_billing_interval, appstle_subscriptions_update_delivery_interval, or switch the selling plan with appstle_subscriptions_update_line_item (selling_plan_name from appstle_subscriptions_list_selling_plans).
• Products and swaps: appstle_subscriptions_add_line_item, appstle_subscriptions_update_line_item, appstle_subscriptions_remove_line_item; appstle_subscriptions_list_product_swaps shows the automatic swap rules.
• Discounts: appstle_subscriptions_apply_discount_code, appstle_subscriptions_add_custom_discount, appstle_subscriptions_remove_discount.
• Delivery and payment: appstle_subscriptions_get_delivery_options, appstle_subscriptions_update_shipping_address, appstle_subscriptions_update_order_note, appstle_subscriptions_send_payment_method_update_email.
• Plans: appstle_subscriptions_list_subscription_groups, appstle_subscriptions_get_subscription_group, appstle_subscriptions_list_selling_plans.
• Analytics: appstle_subscriptions_get_contract_analytics, appstle_subscriptions_get_contract_current_cycle per contract; appstle_subscriptions_get_past_orders_report (status SUCCESS for revenue, FAILURE for failed payments) and appstle_subscriptions_list_retention_activities (cancel and pause flows) across the shop.
• Customer self-service: appstle_subscriptions_get_customer_portal_link creates a login link to the customer portal.

Writes change real subscriptions and usually email the customer. Before a pause, skip, date or product change, say what will change and wait for a yes. appstle_subscriptions_cancel_contract and appstle_subscriptions_bill_order_now are installed switched off: an admin switches them on when the team needs them.

Reading the answers: ids are numeric (contract, customer, billing attempt, group, product, variant), except line ids and discount ids, which are full Shopify GraphQL ids (gid://shopify/SubscriptionLine/...): pass them exactly as returned. Dates are ISO 8601 with time zone (2026-11-01T00:00:00Z). Amounts are in the shop currency. Statuses: contracts ACTIVE, PAUSED, CANCELLED; billing attempts QUEUED (upcoming), SUCCESS, FAILURE, SKIPPED and others.

Paging: list tools take page (from 0) and size (default 20, at most 2000). The total is in _headers.x-total-count; the link header gives the next page. sort takes database column names in snake_case with a direction, e.g. next_billing_date,asc. appstle_subscriptions_get_customer pages contracts with cursor.

Errors: 401 or 403 means the API key is wrong, revoked or the plan has no API access. 400 explains a refused change (e.g. a date in the past, a line below the minimum, an order that is no longer QUEUED). 404 an unknown id. 429 a rate limit: wait and retry.