Xsolla-logo

Update Plan

put/projects/{project_id}/subscriptions/plans/{plan_id}

Updates subscription plan parameters.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

Project ID.

plan_id
required
integer

Plan ID.

Request Body schema: application/json
object

Plan name. Value consists of pairs "localization":"plan name".

object

Billing details.

external_id
string

Plan external ID (32 characters).

object

Plan description. Value consists of pairs "localization":"plan description".

group_id
string

Group ID the plan is linked to.

object

Subscription expiration details.

object

Trial period details. If this parameter is not passed, the default values (0 days) are used.

object

Grace period details.

object

Billing retry details.

refund_period
integer

Period of time that user can refund the payment for a subscription plan (in days).

tags
Array of strings

Plan tags.

object
Responses
200

OK.

Request samples
application/json
{
  • "charge": {
    },
  • "description": {
    },
  • "expiration": {
    },
  • "external_id": "exp",
  • "grace_period": {
    },
  • "billing_retry": {
    },
  • "refund_period": null,
  • "name": {
    },
  • "tags": null,
  • "trial": {
    }
}
Response samples
application/json
{
  • "charge": {
    },
  • "description": {
    },
  • "expiration": {
    },
  • "external_id": "exp",
  • "grace_period": {
    },
  • "billing_retry": {
    },
  • "refund_period": null,
  • "group_id": null,
  • "id": 241082,
  • "localized_name": "Experience boost",
  • "name": {
    },
  • "project_id": 40797,
  • "status": {
    },
  • "tags": [ ],
  • "trial": {
    },
  • "type": "all"
}