App plan subscription payment finalized

Event Group	Event Identification
appsubscription	appsubscription/paid

Occurs whenever a merchant completes the payment process for the app plan subscription, whether successful, canceled, or failed.

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

appkey string

The globally unique identifier for the app.
Example: 56978e0b3f33365396d7786a62ed0a03727e3212
bizOrderNo string

The business order number for the payment order, provided by the app when creating the payment link and used to associate with the app's internal business order.
Example: PAY20240726123456
handle string

The store's unique identifier in SHOPLINE.
Example: shopline
secondChannelId string
The secondary channel identifier for specific sales channels like offline POS stores.
Applicable scenarios:
- When plans are sold per store location: identifies the specific store.
- When plans are sold for the entire store: this parameter is empty.
Example: 4567223323
status integer
Final payment status identifier. Valid enumeration values include:
- 200: Payment successful.
- 300: Payment canceled — the user actively abandoned the payment on the page.
- 400: Payment failed — the user confirmed the payment, but the system failed to charge, possibly due to incorrect account details, insufficient balance, or other system-related reasons.
subId string

The associated subscription order number.
Example: 6578332207010012345
subTime long

The completion time of the payment operation, in the format of a 13-digit millisecond timestamp.
Example: 1722000000000

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

Legal

Privacy