Skip to content
/
Delete Product

Subscriptions API (2.0)

Overview

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

This API reference describes endpoints for managing subscriptions, coupons, and promotions. To get more information about Subscriptions, see the product guide and the glossary.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/subscriptions/

Token

Operations

Plans

Operations

Products

Operations

Update Product

Request

Updates a subscription-based product.

Security
basicAuth
Path
project_idintegerrequired

Project ID.

product_idintegerrequired

Product ID the plans are linked to.

Bodyapplication/jsonrequired
namestringrequired

Product name.

group_idstringrequired

Group ID the product is linked to.

descriptionobject

Localized item descriptions.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/subscriptions/projects/{project_id}/subscriptions/products/{product_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Description in English."
    },
    "group_id": "charge13",
    "name": "Channel23"
  }'

Responses

OK.

Bodyapplication/json
idinteger or null

Product ID the plans are linked to.

namestring

Product name.

group_idstring

Group ID the product is linked to.

descriptionobject

Localized item descriptions.

Response
application/json
{
  "description": {
    "en": "Description in English."
  },
  "group_id": "charge13",
  "id": 1713603,
  "name": "Channel23"
}

Delete Product

Request

Deletes a subscription-based product.

Security
basicAuth
Path
project_idintegerrequired

Project ID.

product_idintegerrequired

Product ID the plans are linked to.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/subscriptions/projects/{project_id}/subscriptions/products/{product_id}'

Responses

No content.

Subscription management

Operations

Payments

Operations

Promotions

Operations

Coupons

Operations

Subscription management

Operations