Skip to main content

Event Overview

Event Type: SUBSCRIPTION_STATUS
Category: Subscription
Description: Subscription status has been updated
This webhook is triggered when a subscription status changes or subscription information is updated.

Delivery Details

AttributeValue
HTTP methodPOST
URLThe webhook URL configured on your merchant account’s API credentials
Content-Typeapplication/json
Timeout10 seconds
RetriesUp to 5 delivery attempts (backoff: 1 min, 5 min, 15 min, 60 min)

Headers

HeaderDescription
Content-Typeapplication/json
User-AgentEximpe-Webhook/1.0
X-Webhook-EventSUBSCRIPTION_STATUS
X-Webhook-TimestampUnix timestamp (string) at the time of the request
X-Webhook-SignatureHMAC-SHA256 signature of the request body (JSON string with keys sorted, no extra whitespace), using your API key as the secret. Hex-encoded.
Signature verification (recommended):
Compute HMAC-SHA256(encryption_key, raw_body) where raw_body is the exact UTF-8 request body as received. Compare the hex result with the X-Webhook-Signature header to ensure the webhook is from the platform and unchanged.

Payload Schema

{
    "event_type": "SUBSCRIPTION_STATUS",
    "event_time": "2024-02-15 16:53:15",
    "version": "2.0.0",
    "sequence_number": "a3791670-7c5d-4a86-aa7a-fe35e58a9dbb",
    "data": {
        "subscriptions": [
            {
                "subscription_id": "SUB123456",
                "status": "ACTIVE",
                "billing_amount": 1000.00,
                "billing_currency": "INR",
                "billing_cycle": "MONTHLY",
                "payment_start_date": "2024-01-01",
                "payment_end_date": "2024-12-31"
            }
        ]
    }
}

Field Specifications

event_type
string
required
Always "SUBSCRIPTION_STATUS" for this webhook event
event_time
string
required
Timestamp when the event occurred in YYYY-MM-DD HH:MM:SS formatExample: "2024-02-15 16:53:15"
version
string
required
Webhook payload version (currently “1.0”)
sequence_number
string
required
Unique identifier for the event instanceExample: "a3791670-7c5d-4a86-aa7a-fe35e58a9dbb"
data
object
required
Event-specific data payload containing subscription details