Nonrenewing subscription

Xsolla Developers

Nonrenewing subscriptionWebhook POST

When a subscription status is set to nonrenewing, Xsolla sends a webhook with the non_renewal_subscription type to the webhook URL. To receive this webhook, contact your Customer Success Manager or email csm@xsolla.com.

Request

Request Body schema: application/json

notification_type

required

string

Notification type.

object

Custom project settings (object).

project_id required	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.
email	string User email.

object

Subscription details (object).

plan_id	string Plan ID (external if the plan was created via API).
subscription_id	integer Subscription ID in Xsolla database.
date_create	string Subscription creation date. Date and time per ISO 8601.
date_next_charge	string Next billing date. This is the date when a next payment was expected before user subscription was set to non-renew. Date and time per ISO 8601.
currency	string Currency. Three-letter currency code per ISO 4217.
amount	number <float> Price in real currency.

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": "non_renewal_subscription",
        "settings": {
          "project_id": 12345,
          "merchant_id": 1234
        },
        "user": {
            "id": "1234567",
            "email": "email@example.com"
        },
        "subscription": {
            "plan_id": "a1bcd2e3",
            "subscription_id": "10",
            "date_create": "2014-12-22T15:25:25+04:00",
            "date_next_charge": "2015-01-22T19:25:25+04:00",
            "currency": "USD",
            "amount": 0.03
        }
    }'

Response samples

application/json

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