smartrr_list_subscriptions
List subscriptions
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.
Parameterspagesortstatuspage_sizecreated_aftercreated_beforenext_billing_afternext_billing_before
smartrr_get_subscription
Get subscription
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}.
Parametersshopify_subscription_idrequired
smartrr_list_customer_subscriptions
List a customer's subscriptions
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/.
Parameterspagestatuspage_sizecustomer_idrequired
smartrr_get_subscription_events
Get subscription history
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.
Parametersshopify_subscription_idrequired
smartrr_get_subscription_orders
List a subscription's orders
Orders generated by one subscription, by its Shopify subscription id. GET /vendor/purchase-state/{shopifySubscriptionId}/orders.
Parameterspagesortpage_sizeshopify_subscription_idrequired
smartrr_get_subscription_bills
List a subscription's bills
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.
Parameterspagesortpage_sizeshopify_subscription_idrequired
smartrr_list_customers
List customers
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.
Parameterspagesortemailpage_sizeshopify_customer_id
smartrr_list_orders
List orders
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.
Parameterspagesortpage_sizeorder_labelprocessed_afterprocessed_before
smartrr_get_order
Get order
One order by its Shopify order id (the `shopifyId` field in smartrr_list_orders, passed as shown). GET /vendor/orders/{shopifyId}.
Parametersshopify_order_idrequired
smartrr_list_bills
List bills
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.
Parameterspagesortstatuspage_sizebilling_afterbilling_before
smartrr_get_bill_history
Get bill history
The audit trail of one bill: every status change, retry and error. GET /vendor/bill/{billId}/history.
Parametersbill_idrequired
smartrr_list_selling_plan_groups
List subscription programs
The store's subscription programs (selling plan groups) and their plans: name, options, delivery and billing frequency, discounts. GET /vendor/selling-plan-group.
Takes no parameters.
smartrr_list_cancellation_reasons
List cancellation reasons
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.
Takes no parameters.
smartrr_get_analytics
Get subscription analytics
Active subscription count and active subscriber count for each day in a date range. GET /vendor/analytics-simple.
Parametersend_daterequiredstart_daterequired
smartrr_pause_subscription
Pause a subscription
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.
Parameterscustomer_idrequiredunpause_daterequiredsubscription_idrequired
smartrr_resume_subscription
Resume a subscription
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.
Parameterscustomer_idrequiredsubscription_idrequirednext_billing_daterequired
smartrr_cancel_customer_subscription
Cancel a customer's subscription
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.
Parametersreason_idrequiredcustomer_idrequiredsubscription_idrequired
smartrr_skip_order
Skip a subscription order
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.
Parametersdatecustomer_idrequiredsubscription_idrequired
smartrr_unskip_order
Unskip a subscription order
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.
Parametersdatecustomer_idrequiredsubscription_idrequired
smartrr_set_next_billing_date
Set next billing date
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.
Parametersdaterequiredcustomer_idrequiredsubscription_idrequired
smartrr_retry_bill
Retry a failed bill
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.
Parametersbill_idrequiredconfirmrequired