API Interface List

This topic provides a list of Yeastar Partner Portal API interfaces.

Authentication

Function	HTTP method	API endpoint
Request Access Token	POST	/auth/openapi/v1/oauth/token
Refresh Access Token	POST	/auth/openapi/v1/oauth/token

Purchase

Function	HTTP method	API endpoint
Query Available Subscription Products	GET	/pricing/openapi/purchase/v1/product_list
Query Available Subscription / Trial Plans and Services for a Product	GET	/pricing/openapi/purchase/v1/purchase_product_info
Query Information about the Plan Available for Trial	GET	/pricing/openapi/purchase/v1/trial/plan_info/{pricingPlanId}
Query Information about the Plan Available for Subscription	GET	/pricing/openapi/purchase/v1/purchase/plan_info/{pricingPlanId}
Query Information about the Plan Available for Renewal	GET	/pricing/openapi/purchase/v1/renew/plan_info/{pricingPlanId}
Query Information about the Service Available for Trial	GET	/pricing/openapi/purchase/v1/trial/add_on_info/{pricingServiceId}
Query Information about the Service Available for Subscription	GET	/pricing/openapi/purchase/v1/purchase/add_on_info/{pricingServiceId}
Query Information about the Service Available for Renewal	GET	/pricing/openapi/purchase/v1/renew/add_on_info/{pricingServiceId}
Query Subscription Price	GET	/pricing/openapi/purchase/v1/my_price_info
Calculate Subscription Price	POST	/pricing/openapi/purchase/v1/pricing/calculate

Order

Function	HTTP method	API endpoint
Query Order List	GET	/order/openapi/order/v1/page
Get Order Details	GET	/order/openapi/order/v1/get/{id}
Query Auto Renewal Status	GET	/order/openapi/order/v1/check/existed_auto_renew
Create an Order	POST	/order/openapi/order/v1/save

Product

Function	HTTP method	API endpoint
Query Product List	GET	/product/openapi/instance_product/v1/client/instance_product_list
Query Product Model	GET	/product/openapi/instance/v1/product_model
Get Product Details	GET	/product/openapi/instance_product/v1/detail
Query Activation Code for P-Series Software Edition	GET	/product/openapi/instance_product/v1/activation_code
Query Region List	GET	/product/openapi/instance/v1/region_list
Check the Existence of PBX URL for P-Series Cloud Edition	GET	/product/openapi/instance/v1/paug_pbx_url_existed
Enable Auto-renewal	POST	/product/openapi/instance_subscription/v1/active
Cancel Auto-renewal	POST	/product/openapi/instance_subscription/v1/cancel

User

Function	HTTP method	API endpoint
Query Account Balance	GET	/user/openapi/user/v1/client/account_balance
Query Subordinate User List	GET	/user/openapi/user/v1/client/partner_list
Query Information of a Subordinate User	GET	/user/openapi/user/v1/subordinate_user
Query Billing Contact List	GET	/user/openapi/user/v1/client/billing_contact_list
Query Country List	GET	/user/openapi/area/v1/page
Create a Subordinate User	POST	/user/openapi/user/v1/client/save_user
Edit a Subordinate User	POST	/user/openapi/user/v1/client/edit_user