` is the `merchant_id:api_key` pair encoded according to the Base64 standard.\nGo to **[Xsolla Publisher Account](https://publisher.xsolla.com/) > Company settings** to find - `merchant_id` on the Company tab
- `api_key` on the API key tab.
",
"scheme": "basic",
"type": "http"
},
"managementJwtAuth": {
"scheme": "bearer",
"type": "http"
},
"projectUserJwtAuth": {
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"description": "# Overview {% #overview %}\n\n* **Version:** 2.0\n* **Servers**: `https://api.xsolla.com/merchant/v2/`\n\nThis API reference describes endpoints for managing subscriptions, coupons, and promotions.\nTo get more information about Subscriptions, see the [product guide](https://developers.xsolla.com/ko/doc/subscriptions) and the [glossary](https://developers.xsolla.com/ko/doc/subscriptions/integration-guide/get-started/#general_glossary).",
"title": "정기 결제 API",
"version": "2.0"
},
"openapi": "3.0.0",
"paths": {
"/api/public/v1/projects/{project_id}/products": {
"get": {
"operationId": "list-public-products",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_ListProductsResponse"
}
}
},
"description": "Subscription's products"
}
},
"security": [],
"summary": "List products (no auth)",
"tags": [
"Client_API_Catalog"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/public/v1/projects/{project_id}/products/{productId}/user_plans": {
"get": {
"operationId": "list-public-plans-by-product",
"parameters": [
{
"in": "query",
"name": "plan_id",
"required": false,
"schema": {
"items": {
"type": "integer"
},
"type": "array"
}
},
{
"in": "query",
"name": "plan_external_id",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "productId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_ListPlansResponse"
}
}
},
"description": "Subscription's plans by product"
}
},
"security": [],
"summary": "List plans by product (no auth)",
"tags": [
"Client_API_Catalog"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/public/v1/projects/{project_id}/user_plans": {
"get": {
"operationId": "list-public-plans",
"parameters": [
{
"in": "query",
"name": "plan_id",
"required": false,
"schema": {
"items": {
"type": "integer"
},
"type": "array"
}
},
{
"in": "query",
"name": "plan_external_id",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_ListPlansResponse"
}
}
},
"description": "Subscription's default plans"
}
},
"security": [],
"summary": "List plans (no auth)",
"tags": [
"Client_API_Catalog"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions": {
"get": {
"operationId": "list-subscriptions",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_ListManagementSubscriptionsResponse"
}
}
},
"description": "Get subscriptions info"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.bad_request",
"description": "Incorrect limit value, maximum allowed is 100"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "List subscriptions",
"tags": [
"User_Management_API_subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/settings": {
"get": {
"operationId": "get-management-settings",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_ProjectManageSubscriptionSettingsResponse"
}
}
},
"description": "Returns project settings for managing subscription"
},
"403": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.access_denied",
"description": "You don't have access to requested project or resource."
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Project not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
},
"500": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Retrieving data from cache has failed."
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Internal server error"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Get management settings",
"tags": [
"User_Management_API_subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}": {
"get": {
"operationId": "get-management-subscription",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_ManagementSubscriptionResponse"
}
}
},
"description": "Get subscription info"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Project with id = 123 was not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Get subscription",
"tags": [
"User_Management_API_subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/activate": {
"put": {
"operationId": "activate-subscription",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"status": "successful"
}
}
},
"description": "Move subscription from non-renew to active"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.bad_request",
"description": "Subscription is not allowed to change to active"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Activate subscription",
"tags": [
"User_Management_API_subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/cancel": {
"put": {
"operationId": "cancel-subscription",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {}
},
"description": "Make subscription non-renewable"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_active",
"description": "Subscription is not active"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Cancel subscription",
"tags": [
"User_Management_API_subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/change_plan": {
"post": {
"operationId": "get-change-plan-link",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_ChangePlanRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_PayStationLinkResponse"
}
}
},
"description": "Returns link to change subscription plan"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Change plan is not possible"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "ubscription with id = 123 not found or not belongs to user"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
},
"500": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Publisher API request failed"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Internal server error"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Get change plan link",
"tags": [
"User_Management_API_subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account": {
"get": {
"operationId": "get-payment-account",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_PaymentRecurrentAccountResponse"
}
}
},
"description": "Get payment account info"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "data.not_found",
"description": "Data not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Get payment account",
"tags": [
"User_Management_API_payment-accounts"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account/manage": {
"post": {
"operationId": "manage-payment-account",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_SandboxRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_PayStationLinkResponse"
}
}
},
"description": "Returns link for managing payment accounts"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Token retrieve error"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription with id = 123 not found or not belongs to user"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
},
"500": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Publisher API request failed"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Internal server error"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Manage payment account",
"tags": [
"User_Management_API_payment-accounts"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts": {
"get": {
"operationId": "list-payment-accounts",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_BillingAccountsListResponse"
}
}
},
"description": "Returns the user's billing accounts"
},
"403": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.access_denied",
"description": "You don't have access to requested project or resource."
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription with id = 123 not found or not belongs to user"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
},
"500": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Publisher API request failed."
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Internal server error"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "List payment accounts",
"tags": [
"User_Management_API_payment-accounts"
]
},
"post": {
"operationId": "link-payment-account",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_LinkPaymentAccountRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"status": "successful"
}
}
},
"description": "Links a payment account to a subscription"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "This account is already linked"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription with id = 123 not found or not belongs to user"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
},
"500": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Publisher API request failed"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Internal server error"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Link payment account",
"tags": [
"User_Management_API_payment-accounts"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts/{payment_account_id}": {
"delete": {
"operationId": "unlink-payment-account",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "payment_account_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"status": "successful"
}
}
},
"description": "Unlink payment accounts"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription with id = 123 not found or not belongs to user"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
},
"500": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Error saving data"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Internal server error"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Unlink payment account",
"tags": [
"User_Management_API_payment-accounts"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change": {
"get": {
"operationId": "list-plans-for-change",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_ListPlansResponse"
}
}
},
"description": "List of available plans for change"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Incorrect limit value, maximum allowed is 100"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription with id = 123 not found or not belongs to user"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "List plans for change",
"tags": [
"User_Management_API_subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change/{plan_id}": {
"get": {
"operationId": "get-plan-for-change",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "plan_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User_Management_API_ChangePlanPaymentDetailsResponse"
}
}
},
"description": "Available plans for change with payment details"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Change plan is not possible"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription with id = 123 not found or not belongs to user"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Not found"
}
},
"security": [
{
"managementJwtAuth": []
}
],
"summary": "Get plan for change",
"tags": [
"User_Management_API_subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/catalog": {
"get": {
"operationId": "get-subscriptions-catalog",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_CatalogResponse"
}
}
},
"description": "Subscription's catalog"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "Get catalog",
"tags": [
"Client_API_Catalog"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/plans": {
"get": {
"operationId": "get-subscription-plans",
"parameters": [
{
"in": "query",
"name": "plan_id",
"required": false,
"schema": {
"items": {
"type": "integer"
},
"type": "array"
}
},
{
"in": "query",
"name": "plan_external_id",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_ListPlansResponse"
}
}
},
"description": "Subscription's default plans"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "List plans",
"tags": [
"Client_API_Catalog"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/products": {
"get": {
"operationId": "get-subscription-products",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_ListProductsResponse"
}
}
},
"description": "Subscription's products"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "List products",
"tags": [
"Client_API_Catalog"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/products/{productId}/plans": {
"get": {
"operationId": "get-subscription-plans-by-product",
"parameters": [
{
"in": "query",
"name": "plan_id",
"required": false,
"schema": {
"items": {
"type": "integer"
},
"type": "array"
}
},
{
"in": "query",
"name": "plan_external_id",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "productId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_ListPlansResponse"
}
}
},
"description": "Subscription's plans by product"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "List plans by product",
"tags": [
"Client_API_Catalog"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/redeem_coupon": {
"post": {
"operationId": "redeem-coupon",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_RedeemCouponRequest"
}
}
},
"description": "Redeem a coupon by its code",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"status": "successful"
}
}
},
"description": "The coupon has been successfully redeemed"
},
"400": {
"content": {
"application/json": {
"examples": {
"already_activated": {
"summary": "The coupon has already been activated",
"value": {
"error": {
"code": "coupon.redemption_error",
"description": "The code you entered has already been activated"
},
"request_id": "b9a3cdfc-f68a-4af8-b9f1-390c6b841849"
}
},
"invalid_code": {
"summary": "Coupon code is invalid",
"value": {
"error": {
"code": "coupon.invalid_code",
"description": "Coupon code is invalid."
},
"request_id": "e8d9c792-76f8-4996-8c2e-30f026180b01"
}
}
}
}
},
"description": "Bad Request"
},
"500": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Publisher API request failed."
},
"request_id": "80c0e8a0-789a-46f3-a1d4-fa0d561f69e1"
}
}
},
"description": "Publisher API request failed"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "Redeem coupon",
"tags": [
"Client_API_Coupons"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/subscriptions": {
"get": {
"operationId": "get-user-active-subscriptions",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_ListSubscriptionsResponse"
}
}
},
"description": "Get subscription info"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "List active subscriptions",
"tags": [
"Client_API_Subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/subscriptions/buy": {
"post": {
"operationId": "buy-subscription",
"parameters": [
{
"in": "query",
"name": "country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_BuySubscriptionRequest"
}
}
},
"description": "Buy subscription",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_PayStationLinkResponse"
}
}
},
"description": "Get buy subscription url"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.plan_not_found",
"description": "Subscription plan not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Subscription plan not found"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "Buy subscription",
"tags": [
"Client_API_Subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/subscriptions/manage": {
"post": {
"operationId": "get-manage-subscriptions-link",
"parameters": [
{
"in": "query",
"name": "country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_ManageSubscriptionRequest"
}
}
},
"description": "Manage subscription",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_PayStationLinkResponse"
}
}
},
"description": "Get manage subscriptions url"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "Get management link",
"tags": [
"Client_API_Subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/subscriptions/user_account": {
"get": {
"operationId": "get-user-account-link",
"parameters": [
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_UserAccountLinkResponse"
}
}
},
"description": "Get user account url"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "Get user account link",
"tags": [
"Client_API_Subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/subscriptions/{subscription_id}": {
"get": {
"operationId": "get-user-subscription",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "query",
"name": "locale",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_SubscriptionResponse"
}
}
},
"description": "Get subscription info"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "Get subscription",
"tags": [
"Client_API_Subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/subscriptions/{subscription_id}/cancel": {
"put": {
"operationId": "cancel-user-subscription",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {}
},
"description": "Make subscription non-renewable"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_active",
"description": "Subscription is not active"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Subscription is not active"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Subscription not found"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "Cancel subscription",
"tags": [
"Client_API_Subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/user/v1/projects/{project_id}/subscriptions/{subscription_id}/renew": {
"post": {
"operationId": "renew-user-subscription",
"parameters": [
{
"in": "path",
"name": "subscription_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_RenewSubscriptionRequest"
}
}
},
"description": "Renew subscription",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client_API_PayStationLinkResponse"
}
}
},
"description": "Get subscription renew url"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.renew",
"description": "Can\\'t renew a subscription"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Can\\'t renew a subscription"
},
"404": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.not_found",
"description": "Subscription not found"
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Subscription not found"
}
},
"security": [
{
"projectUserJwtAuth": []
}
],
"summary": "Renew subscription",
"tags": [
"Client_API_Subscriptions"
]
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/api/v1/projects/{projectId}/subscriptions/user_account": {
"post": {
"operationId": "post-subscriptions-get-user-account-link",
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"pattern": "\\d+",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Admin_API_GetUserAccountRequest"
}
}
},
"description": "Get user account url",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Admin_API_UserAccountLinkResponse"
}
}
},
"description": "Get user account url"
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.bad_request",
"description": "Can't get merchant credentials."
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Bad request"
},
"500": {
"content": {
"application/json": {
"example": {
"error": {
"code": "subscriptions.exception",
"description": "Login API request failed."
},
"request_id": "e54d2081-33cc-4682-b65c-b22d98686d0a"
}
}
},
"description": "Internal server error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get user account link",
"tags": [
"Admin_API_subscriptions"
],
"x-public": true
},
"servers": [
{
"url": "https://subscriptions.xsolla.com"
}
]
},
"/merchants/{merchant_id}/coupon_promotions": {
"post": {
"description": "새로운 쿠폰 캠페인을 생성합니다.\n\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
주의
이 API 메소드는 높은 부하에서는 사용할 수 없습니다. 최대 부하는 분당 20개의 요청입니다.
\n\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n
\n
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
\n