Xsolla-logo

Created subscriptionWebhook POST

When a user creates a subscription, we send a notification to your payment notification script.

Request
Request Body schema: application/json
notification_type
required
string

Type of notification.

object

Custom project settings (object).

project_id
integer

Game’s Xsolla ID. Can be found in Publisher Account.

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_next_charge
string

Next billing date. Date and time per ISO 8601.

object

Trial period (object).

value
integer

Trial period.

type
string

Trial period type: day.

custom_parameters
object

Your custom parameters.

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
application/json
{
  • "notification_type": "string",
  • "settings": {
    },
  • "user": {
    },
  • "subscription": {
    },
  • "custom_parameters": { }
}
Response samples
application/json
{
  • "error": {
    }
}