Change user subscription

Change user current subscription

By default, all users are subscribed to the free plan.

URL: [POST] /api/v1/profile/subscriptions/change

curl -X 'POST' \  'BASE_URL/api/v1/profile/subscriptions/change \  -H 'accept: application/json' \  -H 'Authorization: bearer YOUR_AUTH_TOKEN  -H 'Content-Type: application/json'   -d "{ \"subscriptionPlan\": \"SUBSCRIPTION_PLAN_NUMBER\"}"

Response JSON

{
  "code": 200,
  "message": "Subscription changed successfully",
  "data": {
    "session_id": "0c3e525a-33de-4a85-9fbc-xxx",
    "payment_url": "https://sandbox.woocommerce.com/confirm-subscription/xxxxx",
    "current_subscription": {
      "is_expired": false,
      "is_period_expired": false,
      "id": 1038,
      "is_current": true,
      "subscription_plan": {
        "id": 7,
        "plan_name": "Yearly",
        "recurring_type": "year",
        "amount": 59,
        "is_default": false,
        "subscription_product": {
          "id": 1,
          "name": "Annual TRADEMARK FREE",
          "max_allowed_apps": 1,
          "description": "Get all default APPExperts features + remove APPExperts watermark from your app.",
          "watermark": false,
          "features": []
        }
      },
      "start_date": "2023-05-17T00:00:00+03:00",

Request parameters

Parameter name	Value	Description	Optional
subscriptionPlan	string	Subscription plan ID, different from current plan ID	No

Request parameters

Parameter name	Value	Description	Optional
session_id	string	Subscription created session ID	No
payment_url	string	Checkout page URL	No
current_subscription	object	Current subscription object	No
id	int	ID of the current subscription
is_expired	bool	Bool true if current subscription expired (considering permit days)	No
is_period_expired	bool	Bool true if current subscription expired	No
is_current	bool	Always true in this API	No
start_date	datetime	Start date of current subscription period	No
end_date	datetime	Actual end date of current subscription period, null if not ended	Yes
expected_end_date	datetime	Expected end date for the current subscription period	No
cancel_at_period_end	bool	True if customer requested cancel subscription, false otherwise
subscription_plan	object	Subscription plan object	No
id	int	Subscription plan ID	No
plan_name	string	Subscription plan name	No
recurring_type	string	Subscription plan recurring type: year, month, week	No
amount	int	Subscription plan amount	No
is_default	bool	True if this plan is the free plan, false otherwise	No
subscription_product	object	Subscription product object	No
id	int	Subscription product ID	No
name	string	Subscription product name	No
max _allowed _apps	int	Max allowed apps to be created by the client	No
description	string	Subscription product description	No
watermark	bool	False if watermark is removed, true otherwise	No
features	array	Array of features the user will have by subscribing to this plan	No