SUBSCRIPTION STATUS

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

Attribute	Value
HTTP method	`POST`
URL	The webhook URL configured on your merchant account’s API credentials
Content-Type	`application/json`
Timeout	10 seconds
Retries	Up to 5 delivery attempts (backoff: 1 min, 5 min, 15 min, 60 min)

Headers

Header	Description
`Content-Type`	`application/json`
`User-Agent`	`Eximpe-Webhook/1.0`
`X-Webhook-Event`	`SUBSCRIPTION_STATUS`
`X-Webhook-Timestamp`	Unix timestamp (string) at the time of the request
`X-Webhook-Signature`	HMAC-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": "1.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

Root Level Fields
Data Object Fields

string

required

Always "SUBSCRIPTION_STATUS" for this webhook event

string

required

Timestamp when the event occurred in YYYY-MM-DD HH:MM:SS formatExample: "2024-02-15 16:53:15"

string

required

Webhook payload version (currently “1.0”)

string

required

Unique identifier for the event instanceExample: "a3791670-7c5d-4a86-aa7a-fe35e58a9dbb"

object

required

Event-specific data payload containing subscription details

array

required

Array of subscription objects containing the subscription information

string

required

Unique subscription identifierExample: "SUB123456"

string

required

Current status of the subscriptionExample: "ACTIVE"

number

required

Billing amount for the subscriptionExample: 1000.00

string

required

Currency code for the billing amountExample: "INR"

string

required

Billing cycle frequencyExample: "MONTHLY"

string

required

Start date for subscription payments in YYYY-MM-DD formatExample: "2024-01-01"

string

required

End date for subscription payments in YYYY-MM-DD formatExample: "2024-12-31"

Order

Payment

Card Tokens

Merchant

Settlement

Refund

Subscriptions

Payment Links

Utilities

Webhooks

Event Overview

Delivery Details

Headers

Payload Schema

Field Specifications

​Event Overview

​Delivery Details

​Headers

​Payload Schema

​Field Specifications

Event Overview

Delivery Details

Headers

Payload Schema

Field Specifications