Help Center/ Customer Operation Capabilities/ API Reference/ Customer Operations Capability API
Updated on 2024-09-26 GMT+08:00

Customer Operations Capability API

Huawei Cloud provides the operation capabilities for customers to manage products, accounts, transactions, bills, and invoices on the customer platform.

Table 1 APIs and descriptions

Scenario

Sub-Scenario

API Name

Description

Managing products

Querying product information

Querying Cloud Service Types

This API is used to query cloud service types on the customer self-built platform.

Querying Resource Types

This API is used to query the resource types on the customer self-built platform.

Querying Resources by Cloud Service Type

This API is used to query the resource type code and name by associated cloud service on the self-built platform and to query the price of a pay-per-use or yearly/monthly product.

Querying Usage Types

This API is used to query resource usage types on the customer self-built platform.

Querying Measurement Units

This API is used to query the resource usage, measurement unit for the duration and amount of a yearly/monthly resource, as well as the measurement unit type on the self-built platform.

Querying the Measurement Unit Number System

This API is used to query the measurement unit number system on the self-built platform.

Querying the price of a product

Querying the price of a pay-per-use product

Customers can query the price of a pay-per-use product by criteria on the self-built platform.

Querying the price of a yearly/monthly product

Customers can use this API to query prices of yearly/monthly products for new subscriptions on their platforms.

Querying the Renewal Price of a Yearly/Monthly Resource

Customers can query the renewal price of a yearly/monthly resource by criteria on a self-built platform.

Managing accounts

-

Querying the Account Balance

This API can be used to query the account balance for a customer.

Managing transactions

Managing coupons

Querying Coupons

Customers can query information about their coupons.

Managing yearly/monthly orders

Querying Orders

After a customer purchases yearly/monthly resources, it can query the orders in different statuses, such as in the pending approval, processing, canceled, completed, and pending payment statuses.

Querying Order Details

Customers can view order details on the self-built platform.

Querying Available Discounts of an Order

A customer can query available discounts when paying an order on the self-built platform.

Paying Yearly-Monthly Product Orders

A customer can invoke this API to pay yearly-monthly product orders in the pending payment status.

Canceling Orders in the Pending Payment Status

A customer can invoke this API to cancel orders in the pending payment status.

Querying the Amount of Unsubscription Orders

A customer can query the resources and original orders of the unsubscription amount for an unsubscription or degrade order on the partner sales platform.

Managing yearly/monthly resources

Querying Customer's Yearly/Monthly Resources

A customer can query one or all yearly/monthly resources on the self-built platform.

Renewing subscription to yearly/monthly resources

A customer can renew subscription to yearly/monthly resources on the self-built platform.

Unsubscribing from yearly/monthly resources

If a customer has subscribed to a yearly/monthly resource, the customer can use this API to unsubscribe from the resource, including the renewed part and currently used part. The customer cannot use the resources after unsubscription.

Enabling Automatic Subscription Renewal for Yearly/Monthly Resources

A customer can use this API to enable automatic subscription renewal for its long-term yearly/monthly resources to prevent the resources from being deleted when they are expired.

Disabling Automatic Subscription Renewal for Yearly/Monthly Resources

A customer can disable automatic subscription renewal when needed. After disabling this function, the customer needs to manually renew the subscription to the resources before they expire.

Enabling/Canceling the Change from Yearly/Monthly to Pay-per-Use upon Expiration

A customer can change the billing mode of resources from yearly/monthly to pay-per-use after the resources expire. The pay-per-use mode takes effect upon a yearly/monthly expiration.

Resource package management

Querying resource packages

A customer can query resource packages on the self-built platform.

Querying the Resource Package Usage

Customers can query the resource package usage on the self-built platform by resource.

Querying Resource Package Usage Details

Customers can query the resource usage details on their self-built platform.

Managing bills

Managing bills

Querying Summary Bills

This API can be used to query the expenditure summary bills of a customer on the self-built platform. The bills summarize the summary data by month.

Viewing Resource Usage Details

This API can be used to query usage details of each resource for a customer on the self-built platform.

Viewing Resource Expenditures

This API can be used to query expenditures of each resource for a customer on the self-built platform.

Managing costs

Managing costs

Querying Cost Data

This API is used to query the cost data on the self-built platform.

Managing the enterprise

Manages enterprise projects.

Enabling the Enterprise Project Management

This API is used to enable the enterprise project management on your own platform.

Managing invoices

Managing invoices

Querying the Invoice List

Customers can query the invoice list.