Subscription contract cancellation

Event GroupEvent Identification
subscribesubscribe/cancelled
Subscription contract cancellation
Request Headers
  • X-Shopline-Topic string required
    The unique identifier for the event.
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    The store domain.
    Example: example.myshopline.com
  • X-Shopline-Shop-Id string required
    The store ID.
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    The merchant ID.
    Example: 2000001234
  • X-Shopline-API-Version string required
    The API version.
    Example: v20250601
  • X-Shopline-Webhook-Id string required
    The ID of this Webhook event.
    Example: b54557e48a5fbf7d70bcd043
Request Body
  • billing_policyobject
    Billing strategy information
  • interval string
    Interval units ( day , MONTH , weed , year )
  • interval_count integer
    Interval value
  • max_cycles integer
    Maximum cycle
  • minCycles integer
    Minimum cycle
  • delivery_policyobject
    Shipping plan
  • delivery_name string
    Shipping plan name
  • delivery_seq string
    Shipping plan single
  • event_type string
    Event type
  • id string
    Subscription contract single number
  • line_itemsobject[]
    The information for contract lines.
  • amount string
    The amount of the product with a precision of 2 decimal places, eg, '88.10'.
  • amount_setobject
    The product's amount in multi-currency.
  • presentment_moneyobject
    The monetary information of the buyer side.
  • amount string
    The amount of the product with a precision of 2 decimal places, eg, '88.10'.
  • currency_code string
    The currency code.
  • shop_moneyobject
    The monetary information of the seller side.
  • amount string
    The amount of the product with a precision of 2 decimal places, eg, '88.10'.
  • currency_code string
    The currency code.
  • attributesobject[]
    The attributes of the products.
  • key string
    The attribute key or name of the product.
  • value string
    The attribute value of the product.
  • group_id string
    The group ID of the line item.
  • id string
    The unique ID of the contract line item.
  • image_url string
    The image URL of the product.
  • pricing_policyobject[]
    The discount information for the selling plan.
  • cycle_discountsobject[]
    The adjustment of the subscription cycles.
  • adjustment_type string
    The type of discounts: FIXED_AMOUNT: a fixed amount discount PERCENTAGE: a percentage discount.
  • adjustment_value long
    The discount value in amount or a percentage.
  • product_source string
    The source of the product: main_site: for main site products customize: for customized products
  • quantity string
    The quantity of the product.
  • sku string
    The item number of the product.
  • title string
    The title of the product.
  • variant_id string
    The SKU of the line item.
  • status string
    Contract status , ACTIVE、PAUSED、EXPIRED、CANCELLED、FAILED
  • store_id string
    store ID
Status Codes
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OK
For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.