Canceled subscription

Xsolla Developers

To Publisher Account

Canceled subscriptionWebhook POST

When a subscription is canceled, Xsolla sends a webhook with the cancel_subscription type to the webhook URL.

Request

Request Body schema: application/json

notification_type

required

string

Notification type.

object

Custom project settings (object).

project_id	integer Project ID. You can find this parameter in your Publisher Account next to the name of the project.
merchant_id	integer Merchant ID.

object

User details (object).

id required	string User ID.
name	string Username.

object

Subscription details (object).

plan_id	string Plan ID (external if the plan was created via API).
tags	Array of strings Plan tags.
subscription_id	integer Subscription ID in Xsolla database.
product_id	string Product ID (if sent in the access token).
date_create	string Subscription creation date. Date and time per ISO 8601.
date_end	string Subscription termination date. Date and time per ISO 8601.

Responses

204

Return to indicate successful processing.

400

Return in case of an error in the provided information (e.g., a required parameter missing, failed authorization, etc.).

500

Return to indicate temporary errors with your servers.

Request samples

CURL
PHP
HTTP

curl -v 'https://your.hostname/your/uri' \
-X POST \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Signature 13342703ccaca5064ad33ba451d800c5e823db8f' \
-d '{
        "notification_type": "cancel_subscription",
        "settings": {
          "project_id": 18404,
          "merchant_id": 2340
        },
        "user": {
            "id": "1234567",
            "name": "John Smith"
        },
        "subscription": {
            "plan_id": "b5dac9c8",
            "subscription_id": "10",
            "product_id": "Demo Product",
            "date_create": "2014-09-22T19:25:25+04:00",
            "date_end": "2015-01-22T19:25:25+04:00"
        }
    }'

Response samples

application/json

{"error": {"code": "INVALID_USER",
"message": "Invalid user"
}
}