sealsubscriptions_list_subscriptions
List subscriptions
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.
输入参数pagequerycursorstatuswith_itemswith_billing_attempts
sealsubscriptions_list_subscriptions_by_billing_date
List subscriptions by billing date
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.
输入参数cursorto_datetime必填from_datetime必填
sealsubscriptions_get_subscription
Get subscription
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=.
输入参数subscription_id必填
sealsubscriptions_list_subscription_rules
List subscription rules
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.
输入参数page
sealsubscriptions_get_subscription_rule
Get subscription rule
One subscription rule by id, with its products, variants and selling plans. GET /subscription-rule?id=.
输入参数rule_id必填
sealsubscriptions_list_webhooks
List webhooks
List the webhooks registered for this shop through the API (topic and address). GET /webhooks.
无需输入参数。
sealsubscriptions_pause_subscription
Pause subscription
WRITE: Pause an active subscription: no further charges or shipments until it is resumed. Undo with sealsubscriptions_resume_subscription. PUT /subscription action=pause.
输入参数subscription_id必填
sealsubscriptions_resume_subscription
Resume subscription
WRITE: Resume a paused subscription so charges and shipments continue on the schedule. PUT /subscription action=resume.
输入参数subscription_id必填
sealsubscriptions_reactivate_subscription
Reactivate subscription
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.
输入参数subscription_id必填
sealsubscriptions_cancel_customer_subscription
Cancel subscription
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.
输入参数subscription_id必填
sealsubscriptions_schedule_cancellation
Schedule subscription cancellation
WRITE: Schedule the cancellation of a subscription for a future date and time (it stays active until then). PUT /subscription-schedule-cancellation.
输入参数date必填time必填timezone必填subscription_id必填
sealsubscriptions_add_items
Add items to subscription
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.
输入参数items必填subscription_id必填
sealsubscriptions_edit_items
Edit subscription items
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.
输入参数items必填subscription_id必填
sealsubscriptions_remove_items
Remove items from subscription
WRITE: Remove items from a subscription by item id. The customer stops receiving and paying for them. PUT /subscription action=remove_items.
输入参数item_ids必填subscription_id必填
sealsubscriptions_edit_subscription
Edit subscription
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.
输入参数s_zips_citys_phones_companys_countrys_address1s_address2s_provinces_last_names_first_namedelivery_prices_country_code另有 11 个
sealsubscriptions_reschedule_billing_attempt
Reschedule billing attempt
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.
输入参数date必填time必填timezone必填reset_schedulesubscription_id必填billing_attempt_id必填
sealsubscriptions_skip_billing_attempt
Skip billing attempt
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.
输入参数subscription_id必填billing_attempt_id必填
sealsubscriptions_unskip_billing_attempt
Unskip billing attempt
WRITE: Bring back a skipped billing attempt, so it is charged on its date again. PUT /subscription-billing-attempt action=unskip.
输入参数subscription_id必填billing_attempt_id必填
sealsubscriptions_delete_billing_attempt
Delete billing attempt
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.
输入参数subscription_id必填billing_attempt_id必填
sealsubscriptions_reschedule_fulfillment_order
Reschedule fulfillment order
WRITE: Move a fulfillment order of a prepaid subscription to another date and time. PUT /subscription-fulfillment-order action=reschedule.
输入参数date必填time必填timezone必填subscription_id必填fulfillment_order_id必填
sealsubscriptions_create_charge_now
Charge subscription now
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.
输入参数reset_schedulesubscription_id必填
sealsubscriptions_process_charge
Process a specific charge
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.
输入参数subscription_id必填billing_attempt_id必填
sealsubscriptions_apply_discount_code
Apply discount code
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.
输入参数discount_code必填subscription_id必填
sealsubscriptions_remove_discount_code
Remove discount code
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.
输入参数subscription_id必填discount_code_id必填
sealsubscriptions_send_payment_method_update_email
Email customer to update payment method
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.
输入参数subscription_id必填
sealsubscriptions_edit_subscription_rule
Edit subscription rule
WRITE: Edit a subscription rule: its name, the plan selector label (`options`, e.g. "Deliver every") and the products it applies to. 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.
输入参数nameoptionsrule_id必填product_variants
sealsubscriptions_append_rule_product_variants
Add products to subscription rule
WRITE: Add products or variants to a subscription rule without touching the ones already linked. PUT /subscription-rule/append-product-variants.
输入参数rule_id必填product_variants必填