Tutorial: Switch Subscription Plan for P-Series Cloud PBX (PCE Instance) Using API

This tutorial introduces the request parameters and provides a request example to show you how to switch subscription plan for P-Series Cloud PBX (PCE Instance) using API.

Before you begin: Understand the request parameters

Before switching subscription plan using API, we recommend that you read the table below to understand the request parameters and collect the corresponding values.


Item	Parameter	Description
Operation Type	`operationType`	The operation type. In this scenario, the value is fixed at `switch_plan`.
Product ID	`productId`	Specify the product for which you want to switch subscription plan. The Product ID for P-Series Cloud PBX (PCE Instance) is `13`.
PBX Serial Number (SN)	`productNo`	Specify the device for which you want to switch subscription plan. You will need to query the PBX SN as described in the following steps.
Billing Contact ID	`billingId`	Specify the contact who can receive the invoice after you switch subscription plan. You will need to query the Billing Contact ID as described in the following steps.
Plan Type	`serviceType`	The plan type. In this scenario, the value is fixed at `plan`.
Plan ID	`serviceId`	Specify the specific plan to which you want to switch. You will need to query the plan ID as described in the following steps.
Purchase Type	`purchaseType`	The purchase type. In this scenario, the value is fixed at `switch`.
Billing Model	`billingModel`	The billing model. In this scenario, the value is fixed at `recurring`.
Billing Model	`billingModel`	The billing model. In this scenario, the value is fixed at `recurring`.
Billing Cycle	`billingCycle`	The billing cycle of P-Series Cloud PBX (PCE Instance). In this scenario, the value is fixed at `annually` or `monthly`. Important: If you switch to a higher plan, you can NOT change the billing cycle. For example, if a PBX has been subscribed to Enterprise Plan on a monthly basis and is to switch to Ultimate Plan, the value of Billing Cycle can only be `monthly`.
Multi Cycle	`multiCycle`	The interval of recurring billing. In this scenario, the value is fixed at `0`.

Step 1. Get Serial Number (SN)

Make a request to the Query Product List API endpoint with the Product ID 13.
```
GET {base_url}/product/openapi/instance_product/v1/client/instance_product_list?productId=13
```
Note down the returned value of productNo for the desired P-Series Cloud PBX (PCE Instance).

Step 2. Get plan ID

Make a request to the Query Available Subscription / Trial Plans and Services for a Product API endpoint with the Product ID 13.
```
GET {base_url}/pricing/openapi/purchase/v1/purchase_product_info?productId=13
```
Note down the returned value of planId for the desired plan.

Step 3. Get billing contact ID

Make a request to the Query Billing Contact List API endpoint.

GET {base_url}/user/openapi/user/v1/client/billing_contact_list

Note down the returned value of billingContactId for the desired billing contact.

Step 4. Switch subscription plan for P-Series Cloud PBX (PCE Instance)

Make a request to the Create an Order API endpoint with the collected values.

POST {base_url}/order/openapi/order/v1/save

In this tutorial, the values we collect are shown below:


Item	Parameter	Value
Operation Type	`operationType`	switch_plan
Product ID	`productId`	13
PBX Serial Number (SN)	`productNo`	3658B431119665QJ
Billing Contact ID	`billingId`	3197218168379846218
Plan Type	`serviceType`	plan
Plan ID	`serviceId`	3048572026291630080 (ID for Ultimate Plan)
Purchase Type	`purchaseType`	switch
Billing Model	`billingModel`	recurring
Billing Cycle	`billingCycle`	annually
Multi Cycle	`multiCycle`	0

The sample request to switch from Enterprise Plan to Ultimate Plan for a P-Series Cloud PBX (PCE Instance) is shown below:

POST /order/openapi/order/v1/save HTTP/1.1
Host: openapi.partner.yeastar.com
Content-Type: application/json
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTE1NDU0NDY4NzY3NzQ0XCIsXCJ1c2VyQ29kZVwiOlwiUGFydG5lclwiLFwidXNlcklkXCI6XCIzMDc2OTE1NDU0NDg5NzM5MjY0XCIsXCJ1c2VybmFtZVwiOlwicGFydG5lcmV4YW1wbGVAb3V0bG9vay5jb21cIn0iLCJ1c2VyX25hbWUiOiJwYXJ0bmVyZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3Mzk3MTc5MjYsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwianRpIjoidmlzMkh0QkxaUStNQmxPbS9UdThWR1pyNFljPSIsImF1dGhvcml0aWVzIjpbIjc5Il0sImNsaWVudF9pZCI6IjE0NDI5NjM2ODBiMjM0YjA0YmRjZDVjMTZmODcyOWQ2In0.RPRoTJRkXCB4krDSwGRpUFyCfUVv2LHjIiBICA1pCiY

{
  "operationType": "switch_plan",
  "productId": 13,
  "productNo": "3658B431119665QJ",
  "billingId": 3197218168379846218,
  "serviceList": [
    {
      "serviceType": "plan",
      "serviceId": 3048572026291630080,
      "purchaseType": "switch",
      "billingModel": "recurring",
      "billingCycle": "annually",
      "multiCycle": 0
    }
  ]
}

Result

The sample response is shown below:

{
    "code": "success",
    "detailMessage": "",
    "requestId": "c391736448199cf402a4c016816b70fc",
    "result": {
        "instanceId": "1282352",
        "orderNo": "HF3206250022896930816",
        "orderStatus": "succeed",
        "productNo": "3658B431119665QJ",
        "transactionNo": "CQ3206250025447067649"
    },
    "status": 200
}