# Alibaba Cloud Alibaba Cloud Billing API > Alibaba Cloud Alibaba Cloud Billing API on Apizie: 95 endpoints (Creates a financial relationship, Allocates resource instances (instance-based and attached-resource-based) from a source financial unit to a…, Submits an invoice application, Cancels an unpaid order, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-bssopenapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-bssopenapi` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/bssopenapi - Page: https://apizie.tech/api/cloud/aliyun-bssopenapi - OpenAPI: https://apizie.tech/api/cloud/aliyun-bssopenapi/openapi.json Alibaba Cloud OpenAPI for Alibaba Cloud Billing (bssopenapi, version 2017-12-14). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Creates a financial relationship `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/add-account-relation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | RelationType | string | yes | The type of the financial relationship. Set the value to enterprise_group | | ParentUserId | integer | yes | The ID of the Alibaba Cloud account that is used as the management account | | ChildNick | string | no | The display name of the member. This helps clarify the scenario in which the account is used | | ChildUserId | integer | yes | The ID of the Alibaba Cloud account that is used as the member | | RequestId | string | yes | The unique ID of the request. The ID is used to mark a request and troubleshoot a problem | | PermissionCodes | string | no | The permissions that can be granted to the member. Valid values: SYNCHRONIZE_FINANCE_IDENTITY: allows the credit control identity to be… | | RoleCodes | string | no | The roles that can be assigned to the member. Set the value to trusteeship (JSON-encoded) | ### Allocates resource instances (instance-based and attached-resource-based) from a source financial unit to a… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/allocate-cost-unit-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | FromUnitUserId | integer | yes | The ID of the owner of the source financial unit. This parameter is required | | FromUnitId | integer | yes | The ID of the source financial unit. This parameter is required. 0 indicates the unallocated financial unit ID. A value greater than 0… | | ToUnitUserId | integer | yes | The ID of the owner of the destination financial unit | | ToUnitId | integer | yes | The ID of the destination financial unit. Valid values: -1: moves the allocated resource to the unallocated state. A value greater than 0:… | | ResourceInstanceList | string | yes | The list of resource instances (JSON-encoded) | ### Submits an invoice application `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/apply-invoice` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | InvoiceAmount | integer | yes | The requested invoice amount, in cents | | CustomerId | integer | yes | The ID of the invoice title information, which corresponds to the ID parameter returned by the QueryInvoicingCustomerList operation | | AddressId | integer | yes | The ID of the mailing address, which corresponds to the ID parameter returned by the QueryCustomerAddressList operation | | InvoicingType | integer | no | The invoice type. Valid values: 0: VAT special invoice. 1: VAT general invoice | | ProcessWay | integer | no | The invoicing channel. Set this parameter to 1. Valid values: 0: Processed by Alibaba Cloud. 1: Processed by the tax platform | | ApplyUserNick | string | yes | The nickname of the applicant. The system does not verify this parameter | | InvoiceByAmount | string | no | Specifies whether to issue the invoice based on a specified amount. If this parameter is set to true, the invoice is applied for based on… | | UserRemark | string | no | The user remarks | | SelectedIds | string | yes | The list of IDs of the selected objects to be invoiced, which correspond to the ID parameters returned by the QueryEvaluateList operation… | | emails | string | no | The email addresses for receiving the invoice. The maximum length of this field is 200 characters. Separate multiple email addresses with… | ### Cancels an unpaid order `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/cancel-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | OrderId | string | yes | The order ID | ### Deducts user quota consumption `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/change-reseller-consume-amount` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | AdjustType | string | yes | The adjustment direction of the consumption amount. Valid values: increase: Increases the consumption amount. decrease: Decreases the… | | Amount | string | yes | The adjustment amount in CNY. The amount must be greater than 0 | | Currency | string | yes | The currency | | BusinessType | string | yes | The business type | | Source | string | yes | The request source. Specify the system name | | OutBizId | string | yes | The external business primary key ID used for idempotence verification | | ExtendMap | string | no | The extended message fields | ### Confirms an invitation initiated by the main account for a linked account `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/confirm-relation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | RelationType | string | no | The relationship type. Valid values: enterprise_group | | ParentUserId | integer | no | The Alibaba Cloud UID of the main account | | ConfirmCode | string | yes | The confirmation action. Valid values: child_agree: The linked account agrees. child_disagree: The linked account rejects. 主账号取消确认: The… | | ChildUserId | integer | no | The Alibaba Cloud UID of the linked account | | RequestId | string | yes | The unique identifier of the request | | PermissionCodes | string | yes | The permissions granted to the linked account. Valid values: SYNCHRONIZE_FINANCE_IDENTITY: Allows synchronizing the credit-based payment… | | RelationId | integer | no | The relationship ID. You can obtain the value from the relationId field in the response of the QueryRelationList operation | ### Changes the subscription type for an instance. Currently, this operation supports converting pay-as-you-go… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/convert-charge-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductType | string | no | The product type | | SubscriptionType | string | yes | The current billing method of the instance. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go. After a successful call,… | | Period | integer | no | The subscription period in months. If you convert the billing method to subscription, specify the subscription period. Valid values: 1 to… | | ProductCode | string | yes | The product code | | InstanceId | string | yes | The instance ID | ### Creates an account linking relationship `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/create-ag-account` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | LoginEmail | string | yes | The logon email address of the member account | | AccountAttr | string | no | The properties of the new account. In the console, click Account Properties in the top menu bar to go to the Security Settings page and… | | EnterpriseName | string | no | The name of the enterprise. This is the enterprise name that corresponds to the Unified Social Credit Code | | FirstName | string | no | The first name of the user under the level 1 category | | LastName | string | no | The last name of the user. Maximum length: 64 characters | | NationCode | string | no | The country code | | ProvinceName | string | no | The name of the province. This parameter is optional | | CityName | string | no | The name of the city in English | | Postcode | string | no | The postal code | ### Creates financial units. Batch creation is supported `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/create-cost-unit` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | UnitEntityList | string | no | The list of financial units (JSON-encoded) | ### Creates an instance resource. This operation creates an order for a new instance resource and completes… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/create-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The product code. You can call the QueryProductList operation to query the product code | | ProductType | string | no | The product type | | SubscriptionType | string | yes | The billing method. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go | | Period | integer | no | The subscription period. Unit: months. For yearly subscription products, specify a multiple of 12 | | RenewalStatus | string | no | The auto-renewal status. Valid values: AutoRenewal: auto-renewal is enabled. ManualRenewal: manual renewal. Default value: ManualRenewal | | RenewPeriod | integer | no | The auto-renewal epoch. Unit: months. This parameter is required when you set RenewalStatus to AutoRenewal in Settings | | ClientToken | string | no | The client idempotency token. The server checks whether a request with the same ClientToken has been made. If yes, the server returns the… | | Logistics | string | no | The logistics address for this order. This parameter is typically valid for orders of physical products | | Parameter | string | no | The list of modules (JSON-encoded) | | PricingCycle | integer | no | The unit of the subscription period. PricingCycle=1: The unit of the subscription period is year. PricingCycle=2: The unit of the… | ### Creates a user quota ledger and a quota consumption ledger `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/create-reseller-user-quota` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | Amount | string | yes | The amount in CNY. This parameter is required to activate a quota | | Currency | string | yes | The currency | | OutBizId | string | no | The business transaction ID of the external system | ### Deletes a financial unit `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/delete-cost-unit` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | OwnerUid | integer | yes | The ID of the owner of the financial unit | | UnitId | integer | yes | The ID of the financial unit. A value of -1 indicates the root financial unit | ### Queries a summary of cost budgets `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-cost-budgets-summary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BudgetName | string | no | The name of the budget. Supports fuzzy search | | BudgetStatus | string | no | The status of the budget. If you do not specify this parameter, budgets in all statuses are returned | | BudgetType | string | no | The type of the budget. If you do not specify this parameter, budgets of all types are returned | | NextToken | string | no | The token that is used to retrieve the next page of results. Set this parameter to the NextToken value that is returned in the response to… | | MaxResults | integer | no | The maximum number of items to return. Valid values: 1 to 10. Default value: 10 | ### Queries the monthly amortized costs of instances by amortization month `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-instance-amortized-cost-by-amortization-period` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The amortization month. Format: YYYY-MM | | ConsumePeriodFilter | string | no | The billing cycle filter. Maximum number of elements: 10 (JSON-encoded) | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: Upfront. PayAsYouGo: Pay-as-you-go | | ProductCode | string | no | The product code. Reference sources for valid values: Call QueryProductList to query product information. Call… | | ProductDetail | string | no | The product detail | | CostUnitCode | string | no | The cost unit code | | BillUserIdList | string | no | The bill purchaser ID filter. The ID of the RAM user. Specify this parameter to view the bills of RAM users. If you do not specify this… | | BillOwnerIdList | string | no | The resource ownership account filter. The ID of the resource ownership account. The resource ownership account is the account that… | | InstanceIdList | string | no | The instance ID filter. You can query multiple instances. If you do not specify this parameter, all instances are queried by default.… | | NextToken | string | no | The token that specifies the position from which the current call starts reading. The value must be empty or set to the NextToken value… | | MaxResults | integer | no | The maximum number of data records to read in the current call. Default value: 20. Maximum value: 300 | ### Queries the monthly amortized costs of instances by billing cycle `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-instance-amortized-cost-by-consume-period` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing cycle. Format: YYYY-MM | | AmortizationPeriodFilter | string | no | The filter for the amortization month. Maximum number of elements: 10 (JSON-encoded) | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go | | ProductCode | string | no | The product code. You can obtain the value from the following operations: QueryProductList: queries product information.… | | ProductDetail | string | no | The product detail | | CostUnitCode | string | no | The code of the cost unit | | BillUserIdList | string | no | The filter for the bill purchaser ID, which is the RAM user ID. Specify this parameter to view the bills of RAM users. If you leave this… | | BillOwnerIdList | string | no | The filter for the resource ownership account. The resource ownership account ID. The resource ownership account is the account that… | | InstanceIdList | string | no | The filter for the instance ID. You can query multiple instances. If you do not specify this parameter, all instances are queried by… | | NextToken | string | no | The token that specifies the position where the current call starts to read. The value must be empty or set to the NextToken value… | | MaxResults | integer | no | The maximum number of data records to read in the current call. Default value: 20. Maximum value: 300 | ### Queries the consumption summary of all product instances or billable items for a user within a specific… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-instance-bill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing cycle in the YYYY-MM format. Only the last 18 billing cycles are supported | | ProductCode | string | no | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go | | IsBillingItem | string | no | Specifies whether to retrieve data by billable item. Valid values: false (default): The data is consistent with the instance bills in… | | NextToken | string | no | The position from which the current call starts to read data. The value must be empty or set to the NextToken value returned in the… | | MaxResults | integer | no | The maximum number of data records to read in the current call. Default value: 20. Maximum value: 300 | | IsHideZeroCharge | string | no | Specifies whether to filter out records where both the original price (PretaxGrossAmount) and the payable amount (PretaxAmount) are 0.… | | BillingDate | string | no | The billing date. This parameter is required only when Granularity is set to DAILY. Format: YYYY-MM-DD. The value of BillingDate must be… | | Granularity | string | no | The granularity at which bills are queried. Valid values: MONTHLY: monthly. The data is consistent with the monthly bills in Expenses and… | | BillOwnerId | integer | no | The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource | | InstanceID | string | no | The instance ID | | PipCode | string | no | The product code, which is consistent with the product code in the bills of the User Center | ### Queries the module information of a specific Alibaba Cloud product `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-pricing-module` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The product code. You can call the QueryProductList operation to query product codes | | ProductType | string | no | The product type. You can call the QueryProductList operation to query product types. The value must be the same as the product type… | | SubscriptionType | string | yes | The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go | ### Queries the monthly amortized costs of products from the perspective of the amortization month `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-product-amortized-cost-by-amortization-period` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The amortization month. Format: YYYY-MM | | ConsumePeriodFilter | string | no | The filter condition for the billing month. Maximum number of elements: 10 (JSON-encoded) | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go | | ProductCode | string | no | The product code. Reference value sources: Call QueryProductList to query product information, or call DescribeResourcePackageProduct to… | | ProductDetail | string | no | The product detail | | CostUnitCode | string | no | The code of the financial unit | | BillUserIdList | string | no | The filter condition for the bill purchaser ID. The ID of the RAM user. Specify this parameter to view the bills of RAM users in Finance… | | BillOwnerIdList | string | no | The filter condition for the resource ownership account. The ID of the resource ownership account. The resource ownership account is the… | | NextToken | string | no | The token that specifies the position from which the current call starts reading. The value must be empty or set to the NextToken value… | | MaxResults | integer | no | The maximum number of data records to return in the current call. Default value: 20. Maximum value: 300 | ### Queries the monthly amortized costs of products by billing cycle month `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-product-amortized-cost-by-consume-period` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing cycle month. Format: YYYY-MM | | AmortizationPeriodFilter | string | no | The filter condition for the amortization month. Maximum number of elements: 10 (JSON-encoded) | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go | | ProductCode | string | no | The product code. Reference sources for valid values: Call QueryProductList to query product information, or call… | | ProductDetail | string | no | The product detail | | CostUnitCode | string | no | The code of the financial unit | | BillUserIdList | string | no | The filter condition for the bill purchaser ID. The ID of the RAM user. Specify this parameter to view the bills of RAM users in Financial… | | BillOwnerIdList | string | no | The filter condition for the resource ownership account. The ID of the resource ownership account. The resource ownership account is the… | | NextToken | string | no | The token that specifies the position from which the current call starts reading. The value must be empty or set to the NextToken value… | | MaxResults | integer | no | The maximum number of data records to return in the current call. Default value: 20. Maximum value: 300 | ### Queries the coverage details of reserved instances and storage capacity units (SCUs) `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-resource-coverage-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | StartPeriod | string | yes | The start time of the query period. Format: yyyy-MM-dd HH:mm:ss. The specified time is included in the query | | EndPeriod | string | no | The end time of the query period. Format: yyyy-MM-dd HH:mm:ss. The specified time is excluded from the query. If this parameter is left… | | PeriodType | string | yes | The time granularity of the query. Valid values: MONTH: month. DAY: day. HOUR: hour | | NextToken | string | no | The pagination token. Leave this parameter empty when you query the first page. The token for the next page is returned in the response.… | | MaxResults | integer | no | The maximum number of entries to return in a single request. Default value: 20. Maximum value: 300 | | BillOwnerId | integer | no | The ID of the account to which the resource belongs. The resource ownership account is the account that actually uses the resource | | ResourceType | string | yes | The type of the resource. Valid values: RI: reserved instance. SCU: storage capacity unit | ### Queries the coverage summary of reserved instances and storage capacity units (SCUs) `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-resource-coverage-total` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | StartPeriod | string | yes | The start of the query time range. Format: yyyy-MM-dd HH:mm:ss. The query includes this time | | EndPeriod | string | no | The end of the query time range. Format: yyyy-MM-dd HH:mm:ss. The query excludes this time. If this parameter is left empty, the current… | | PeriodType | string | yes | The time granularity. Valid values: MONTH: month DAY: day HOUR: hour | | BillOwnerId | integer | no | The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource | | ResourceType | string | yes | The resource type. Valid values: RI: reserved instance SCU: storage capacity unit | ### Queries the information about resource plans of an Alibaba Cloud service `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-resource-package-product` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The code of the service | ### Queries the usage details of reserved instances and storage capacity units (SCUs) `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-resource-usage-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | StartPeriod | string | yes | The start time of the query. Format: yyyy-MM-dd HH:mm:ss. The specified time is included in the query | | EndPeriod | string | no | The end time of the query. Format: yyyy-MM-dd HH:mm:ss. The specified time is excluded from the query. If this parameter is left empty,… | | PeriodType | string | yes | The time granularity. Valid values: MONTH: Monthly. DAY: Daily. HOUR: Hourly | | NextToken | string | no | The pagination token. Leave this parameter empty when you query the first page. The token for the next page is returned in the response.… | | MaxResults | integer | no | The maximum number of entries to return in a single request. Default value: 20. Maximum value: 300 | | BillOwnerId | integer | no | The ID of the account whose data you want to query. If this parameter is left empty, the data of the current account and its trusteeship… | | ResourceType | string | yes | The type of the resource plan. Valid values: RI: reserved instance. SCU: storage capacity unit | ### Queries the usage summary of reserved instances and storage capacity units (SCUs) `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-resource-usage-total` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | StartPeriod | string | yes | The start time. Format: yyyy-MM-dd HH:mm:ss. The query includes data at this time. This value specifies the start time of the query range | | EndPeriod | string | no | The end time. Format: yyyy-MM-dd HH:mm:ss. The query excludes data at this time. If this parameter is left empty, the query range extends… | | PeriodType | string | yes | The time granularity. Valid values: MONTH: month DAY: day HOUR: hour | | BillOwnerId | integer | no | The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource. Only one account… | | ResourceType | string | yes | The resource plan type. Valid values: RI: reserved instance. SCU: storage capacity unit | ### Queries the details of savings plan coverage `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-savings-plans-coverage-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | StartPeriod | string | yes | The start time of the time range to query. The start time is included in the time range. Specify the time in the yyyy-MM-dd HH:mm:ss format | | EndPeriod | string | no | The end time of the time range to query. The end time is not included in the time range. If you do not specify this parameter, the end… | | PeriodType | string | yes | The time granularity for querying the usage summary. Valid values: MONTH, DAY, and HOUR | | Token | string | no | The pagination token. Leave this parameter empty when you query the first page. The token for the next page is returned in the response.… | | MaxResults | integer | no | The maximum number of results to return | | BillOwnerId | integer | no | The ID of the account with resource ownership. The account with resource ownership is the account that actually uses the resource | | FilterParam | string | no | The filter parameters (JSON-encoded) | ### Queries the savings plan coverage summary `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-savings-plans-coverage-total` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | StartPeriod | string | yes | The start time of the query. Format: yyyy-MM-dd HH:mm:ss. The specified start time is included in the query | | EndPeriod | string | no | The end time of the query. Format: yyyy-MM-dd HH:mm:ss. The specified end time is excluded from the query. If this parameter is left… | | PeriodType | string | yes | The time granularity. Valid values: MONTH: month DAY: day HOUR: hour | | BillOwnerId | integer | no | The ID of the resource ownership account. The resource ownership account is the account that actually uses the resources | | FilterParam | string | no | The filter parameters (JSON-encoded) | ### Queries the usage details of savings plans `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-savings-plans-usage-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | StartPeriod | string | yes | The start time of the query. Format: yyyy-MM-dd HH:mm:ss. The specified time is included in the query | | EndPeriod | string | no | The end time of the query. Format: yyyy-MM-dd HH:mm:ss. The specified time is excluded from the query. If this parameter is left empty,… | | PeriodType | string | yes | The time granularity for querying the usage summary. Valid values: MONTH: monthly DAY: daily HOUR: hourly | | Token | string | no | The pagination token. Leave this parameter empty when you query the first page. The token for the next page is returned in the response.… | | MaxResults | integer | no | The maximum number of data records to return in the current request. Default value: 20. Maximum value: 300 | | BillOwnerId | integer | no | The ID of the account whose data you want to query. If this parameter is left empty, the data of the current account and its trusteeship… | | FilterParam | string | no | The filter parameters (JSON-encoded) | ### Queries the savings plan usage summary `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-savings-plans-usage-total` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | StartPeriod | string | yes | The start time of the time range to query. The start time is included in the time range. Specify the time in the yyyy-MM-dd HH:mm:ss format | | EndPeriod | string | no | The end time of the time range to query. The end time is not included in the time range. If you do not specify this parameter, the end… | | PeriodType | string | yes | The time granularity for querying the usage summary. Valid values: MONTH, DAY, and HOUR | | BillOwnerId | integer | no | The ID of the account with resource ownership, which is the account that actually uses the resources | | FilterParam | string | no | The filter parameters (JSON-encoded) | ### Queries split bills `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/describe-split-item-bill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing cycle. Format: YYYY-MM | | ProductCode | string | no | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go. This parameter must be used together with the… | | NextToken | string | no | The token that specifies the position from which the current call starts to read data. The value must be empty or the value of NextToken… | | MaxResults | integer | no | The maximum number of entries to return in the current call. Default value: 20. Maximum value: 300 | | BillOwnerId | integer | no | The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource | | InstanceID | string | no | The instance ID | | SplitItemID | string | no | The ID of the attached resource | | Granularity | string | no | The granularity at which bills are queried. Valid values: MONTHLY: monthly. This value corresponds to the monthly bills on the Split Bill… | | BillingDate | string | no | The billing date. This parameter is required only when Granularity is set to DAILY. Format: YYYY-MM-DD | | TagFilter | string | no | The tag filter conditions. Multiple sets of TagValues query conditions are supported. The logical relationship between multiple sets of… | | IsHideZeroCharge | string | no | Specifies whether to filter out bills where both the original price (PretaxGrossAmount) and the payable amount (PretaxAmount) are 0. Valid… | | PipCode | string | no | The product code. This value is the same as the product code in the bills of the User Center | ### Queries the details of an account linking `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/get-account-relation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | RelationId | integer | no | The account linking ID | | RequestId | string | no | The unique request ID, used to identify the request and facilitate troubleshooting | ### Queries the account information of an end customer under a partner `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/get-customer-account-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | ### Queries the list of end customer UIDs under a partner `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/get-customer-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | ### Queries the details of a specific order for a user or a distribution customer `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/get-order-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | OrderId | string | yes | The order ID | ### Queries the price of a pay-as-you-go product `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/get-pay-as-you-go-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | yes | The subscription type. Valid values: PayAsYouGo | | Region | string | no | The region ID of the instance | | ModuleList | string | yes | The list of pricing modules (JSON-encoded) | ### Queries the price of a resource plan `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/get-resource-package-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The code of service. You can query the service code by calling the QueryProductList operation or viewing Codes of Alibaba Cloud Services | | PackageType | string | yes | The type of the resource plan. The value must be the same as the value of the ProductCode parameter that is returned when you call the… | | EffectiveDate | string | no | The time when the resource plan takes effect. If you do not specify this parameter, the resource plan immediately takes effect by default.… | | Specification | string | yes | The specifications of the resource plan | | Duration | integer | yes | The validity period of the resource plan. The value must be the same as the duration of the resource plan specified in the specifications | | PricingCycle | string | no | The unit of validity period of the resource plan. Valid values: Month Year | | OrderType | string | no | The type of the order. Valid values: BUY: You place the order to purchase an instance. UPGRADE: You place the order to upgrade an… | | InstanceId | string | no | The ID of the instance. This parameter is required when the order type is renewal or upgrade | ### Queries the prices of subscription products `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/get-subscription-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ServicePeriodUnit | string | no | The unit of the service period. Valid values: Year: years. Month: months | | SubscriptionType | string | yes | The subscription type. Valid value: Subscription (subscription) | | ProductCode | string | yes | The product code | | OrderType | string | yes | The order type. Valid values: NewOrder: new purchase. Renewal: renewal. Upgrade: upgrade | | ServicePeriodQuantity | integer | no | The service period | | ProductType | string | no | The product type. Whether this parameter is required depends on the price inquiry documentation of the specific product | | Region | string | no | The region ID of the instance | | InstanceId | string | no | The ID of the instance for which you want to inquire about the price. This parameter is required in upgrade scenarios to obtain the… | | Quantity | integer | no | The quantity | | ModuleList | string | yes | The list of pricing modules (JSON-encoded) | ### Queries the refund amount for an instance that you want to unsubscribe from `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/inquiry-price-refund-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ClientToken | string | no | Required for idempotent scenarios. A UUID-generated string. This field is used for idempotence. If the same value is passed in multiple… | | ProductCode | string | no | Required for unsubscription scenarios. The product code | | InstanceId | string | no | Required for unsubscription scenarios. The instance ID | | ProductType | string | no | Required for unsubscription scenarios. The product type. Pass an empty string ("") unless otherwise specified | ### Adds or deletes permissions for an account linking relationship `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/modify-account-relation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | RelationType | string | no | The relationship type. Currently, only enterprise_group is supported | | RelationOperation | string | yes | The action to perform. Valid values: ADD: Adds the permission. DELETE: Deletes the permission | | ParentUserId | integer | no | The UID of the Alibaba Cloud account | | ChildNick | string | no | The display name. This name is shown on the page to help you identify the use case of the account | | ChildUserId | integer | no | The UID of the member account | | RequestId | string | yes | The unique ID of the request. This ID is used to mark a request and troubleshoot issues | | RoleCodes | string | no | Modifying roles is not supported (JSON-encoded) | | PermissionCodes | string | no | The permissions that can be modified. Valid values: SYNCHRONIZE_FINANCE_IDENTITY: Allow synchronizing the credit control identity with the… | | RelationId | integer | no | The relationship ID. Obtain this value from the relationId field returned by the QueryRelationList operation | ### Modifies financial units. Batch modification is supported `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/modify-cost-unit` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | UnitEntityList | string | no | The list of financial units (JSON-encoded) | ### Modifies the resource configuration of an instance. Invoking this operation creates an order for the… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/modify-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | yes | The billing method. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go | | ModifyType | string | yes | The type of configuration change. Valid values: Upgrade: upgrade. Downgrade: downgrade | | InstanceId | string | no | The instance ID of the instance whose configuration you want to modify | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions | | Parameter | string | no | The list of parameters (JSON-encoded) | ### Queries the user's account balance `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-account-balance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | ### Queries account spending within a billing cycle and aggregates the data by resource owner `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-account-bill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing date. Format: YYYY-MM | | PageNum | integer | no | The page number. The default value is 1 | | PageSize | integer | no | The number of entries per page. The default value is 20. The maximum value is 300 | | IsGroupByProduct | string | no | Specifies whether to aggregate the results by product code. true: Results are aggregated by product code. false: Results are not… | | ProductCode | string | no | The product code | | BillOwnerId | integer | no | The ID of the account that owns and actually uses the resource | | Granularity | string | no | The granularity for querying the bill. Valid values: MONTHLY: Queries bills on a monthly basis. Corresponds to the monthly bills in… | | BillingDate | string | no | The billing date. This parameter is required only when you set Granularity to DAILY. Format: YYYY-MM-DD | ### Queries the income and expenditure details of account transactions `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-account-transaction-details` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | TransactionNumber | string | no | The transaction number | | RecordID | string | no | The order ID or bill ID | | TransactionChannelSN | string | no | The payment reference No. of the transaction channel | | CreateTimeStart | string | no | The start time of creation | | CreateTimeEnd | string | no | The end time of creation | | TransactionType | string | no | The transaction type. If you specify one of the following transaction types, the query returns results of the specified type. If no… | | TransactionChannel | string | no | The transaction channel. If you specify one of the following transaction channel types, the query returns results of the specified type.… | | NextToken | string | no | The paging token for the paged query | | MaxResults | integer | no | An invalid parameter | ### Queries the transaction records of a user account `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-account-transactions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | TransactionNumber | string | no | The transaction number | | RecordID | string | no | The order or bill number | | TransactionChannelSN | string | no | The payment reference No | | CreateTimeStart | string | no | The start time of the creation time range. If not specified, the default value is one month before the current time. Example:… | | CreateTimeEnd | string | no | The end time of the creation time range. If not specified, the default value is the current time. Example: 2018-01-01T00:00:00Z | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20 | | TransactionType | string | no | The transaction type. If you specify a transaction type, the query returns results of the corresponding type. If no results exist, an… | | TransactionFlow | string | no | The income and expense type. If you specify an income and expense type, the query returns results of the corresponding type. If no results… | | TransactionChannel | string | no | The transaction channel. If you specify a transaction channel, the query returns results of the corresponding type. If no results exist,… | ### Queries the list of available instances for the user `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-available-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | Region | string | no | The region | | PageNum | integer | no | The page number | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 300 | | ProductCode | string | no | The product code. You can call the QueryProductList operation to query product codes. If the region is specified, this parameter cannot be… | | ProductType | string | no | The product type | | SubscriptionType | string | no | The subscription type. Subscription: subscription. PayAsYouGo: pay-as-you-go | | InstanceIDs | string | no | The instance IDs. Separate multiple IDs with commas. You can specify up to 100 IDs | | EndTimeStart | string | no | The start time of the expiration time range. Specify the time in the ISO 8601 standard in the UTC format. Example: 2016-05-23T12:00:00Z | | EndTimeEnd | string | no | The end time of the expiration time range. Specify the time in the ISO 8601 standard in the UTC format. Example: 2016-05-23T12:00:00Z | | CreateTimeStart | string | no | The start time of the creation time range. Specify the time in the ISO 8601 standard in the UTC format | | CreateTimeEnd | string | no | The end time of the creation time range. Specify the time in the ISO 8601 standard in the UTC format | | RenewStatus | string | no | The renewal status. Valid values: AutoRenewal: auto-renewal. ManualRenewal: manual renewal. NotRenewal: no renewal | ### Queries the settlement bills of a user within a specific billing cycle `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-bill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing cycle, in the YYYY-MM format | | Type | string | no | The type. Valid values: SubscriptionOrder PayAsYouGoBill Refund Adjustment | | ProductCode | string | no | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | no | The subscription type. Valid values: Subscription PayAsYouGo This parameter must be used together with the ProductCode parameter | | IsHideZeroCharge | string | no | Specifies whether to filter out bills with a original price (PretaxGrossAmount) of 0. Default value: false (compatible with existing… | | IsDisplayLocalCurrency | string | no | The IsDisplayLocalCurrency | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 300 | | BillOwnerId | integer | no | The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource | ### Queries the bill overview of a user for a specific billing cycle `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-bill-overview` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing date in the YYYY-MM format | | ProductCode | string | no | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: upfront. PayAsYouGo: pay-as-you-go | | BillOwnerId | integer | no | The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource | ### Queries the records of bill subscriptions to OSS buckets `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-bill-to-osssubscription` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | ### Queries user voucher information `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-cash-coupons` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ExpiryTimeEnd | string | no | The end of the expiration time range for the voucher. Format: yyyy-MM-ddTHH:mm:ssZ | | ExpiryTimeStart | string | no | The start of the expiration time range for the voucher. Format: yyyy-MM-ddTHH:mm:ssZ | | EffectiveOrNot | string | no | Specifies whether the voucher is valid. Valid values: true false | ### Retrieves a list of commodity information based on a product code `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-commodity-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The product code | | Lang | string | no | The language. If this parameter is not specified, the default value zh (Chinese) is used | ### Queries all financial unit nodes under the current node of the financial unit tree. If ParentUnitId is set… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-cost-unit` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | OwnerUid | integer | yes | The owner of the financial unit | | ParentUnitId | integer | yes | The ID of the parent financial unit. A value of -1 indicates the root of the financial unit tree | | PageNum | integer | no | The page number | | PageSize | integer | no | The number of entries per page. Maximum value: 300 | ### Queries the list of resource instances that belong to a financial unit of a user. When UnitId is set to 0,… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-cost-unit-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | OwnerUid | integer | yes | The user ID of the financial unit owner | | UnitId | integer | yes | The ID of the financial unit | | PageNum | integer | no | The page number | | PageSize | integer | no | The number of entries per page | ### Queries the Alibaba Cloud invoice mailing address information service `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-customer-address-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | ### Queries the usage of resource plans, including reserved instances (RIs) and storage capacity units (SCUs) `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-dputilization-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | InstanceId | string | no | The instance ID for the filtered query. If this parameter is left empty, the details of all used instances are returned | | InstanceSpec | string | no | The instance type | | CommodityCode | string | no | The commodity code, such as ecsRi and scu_bag. If this parameter is specified, the ProdCode parameter does not take effect | | DeductedInstanceId | string | no | The ID of the deducted instance. If this parameter is left empty, the details of all instances are returned | | StartTime | string | yes | The start time. Format: YYYY-MM-dd HH:mm:ss | | EndTime | string | yes | The end time. Format: YYYY-MM-dd HH:mm:ss | | LastToken | string | no | The token that specifies the start position of the query. Set this parameter to null for the first query. For subsequent queries, use the… | | Limit | integer | no | The number of entries to return per query. Default value: 20. Maximum value: 300 | | IncludeShare | string | yes | Specifies whether to include the resource plan usage of member accounts in finance trusteeship. Valid values: true: Included. false: Not… | | ProdCode | string | no | The product code, such as ecs | ### Queries a list of objects that are eligible for invoicing `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-evaluate-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | Type | integer | no | The type. Valid values: 1: queries objects with a negative invoiceable amount. 2: queries objects with a positive invoiceable amount. 3:… | | OutBizId | string | no | The order ID, bill ID, or contract ID | | PageNum | integer | no | The page number | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 300 | | StartAmount | integer | no | The minimum amount for the query | | EndAmount | integer | no | The maximum amount for the query | | StartBizTime | string | no | The beginning of the time range to query based on the successful payment time. The format is yyyy-mm-dd hh:mm:ss | | EndBizTime | string | no | The end of the time range to query based on the successful payment time. The format is yyyy-mm-dd hh:mm:ss | | SortType | integer | no | The sorting type. Valid values: 1: sorts the results by ID in descending order. 2: sorts the results by type in descending order, and then… | | StartSearchTime | string | no | The start of the time range to query | | EndSearchTime | string | no | The end of the time range to query | | BillCycle | string | no | The billing cycle | | BizTypeList | string | no | The list of invoicing entities to which the invoiceable objects belong (JSON-encoded) | ### Queries the enterprise financial account information of an account that has primary-subsidiary relationship… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-financial-account-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | UserId | integer | yes | The Alibaba Cloud account ID | ### Queries the usage summary of all product instances or billable items for an account in a billing cycle. This… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-instance-bill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing cycle in YYYY-MM format. Data from the last 18 months is supported | | ProductCode | string | no | The code of the product | | ProductType | string | no | The type of the product. Required when the ProductCode parameter is set to the code of an Alibaba Cloud Marketplace product | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go. This parameter must be used with the… | | IsBillingItem | string | no | Specifies whether to query data by billable item. false: The data is consistent with the bill details on the Instance tab of the Bills… | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 300 | | IsHideZeroCharge | string | no | Specifies whether to filter out bills for which the pretax gross amount (PretaxGrossAmount) and pretax amount (PretaxAmount) are both 0.… | | BillingDate | string | no | The billing date. This parameter is required only when the Granularity parameter is set to DAILY. The value must be in the YYYY-MM-DD format | | Granularity | string | no | The granularity at which to query bills. Valid values: MONTHLY: queries bills by month. The data is consistent with the bill details on… | | BillOwnerId | integer | no | The ID of the account that owns the resources. This account is the actual user of the resources | ### Queries a list of instances by tags `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-instance-by-tag` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ResourceType | string | yes | The type of the resource. Set this parameter to `instance` to query savings plan instances | | ResourceId | string | no | A list of resource IDs (JSON-encoded) | | Tag | string | no | A list of tags (JSON-encoded) | ### This API is deprecated. Use the following APIs to retrieve the amortized cost:… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-instance-gaap-cost` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 100 | | BillingCycle | string | yes | The billing cycle, in the YYYY-MM format | | ProductCode | string | no | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | no | The billing method. Valid values: `Subscription`: subscription `PayAsYouGo`: pay-as-you-go | ### Queries the invoicing information of an Alibaba Cloud user `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-invoicing-customer-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | ### Queries the orders of users or distribution customers. By default, this operation queries orders created… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-orders` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | CreateTimeEnd | string | no | The end time of the creation time range. By default, orders created within the last hour are queried. Specify the time in the ISO 8601… | | PageNum | integer | no | The page number | | PageSize | integer | no | The number of entries per page | | ProductCode | string | no | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go | | OrderType | string | no | The order type. Valid values: New: new purchase Renew: renewal Upgrade: upgrade TempUpgrade: temporary upgrade Downgrade: downgrade… | | PaymentStatus | string | no | The payment status. For non-refund orders, valid values: Unpaid: unpaid Paid: paid Cancelled: canceled For refund orders, this parameter… | | CreateTimeStart | string | no | The start time of the creation time range. By default, orders created within the last hour are queried. Specify the time in the ISO 8601… | ### Queries the permissions for a master-member relationship based on the relationship ID `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-permission-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | RelationId | integer | yes | The relationship ID. Obtain this ID from the RelationId parameter in the response of the QueryRelationList operation | ### Queries user card package information `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-prepaid-cards` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ExpiryTimeEnd | string | no | The end time of card package expiration. Format: yyyy-MM-dd HH:mm:ss | | ExpiryTimeStart | string | no | The start time of card package expiration. Format: yyyy-MM-dd | | EffectiveOrNot | string | no | Specifies whether the card package is effective. Valid values: true: Effective. false: Ineffective | ### Queries the pricing entities under a commodity. A pricing entity is the smallest product capability used for… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-price-entity-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | CommodityCode | string | yes | The commodity code. You can call the QueryCommodityList operation to query the commodity code | | Lang | string | no | The language. Default value: zh (Chinese) | ### Queries the list of products available for the current account to order. The response includes the product… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-product-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | QueryTotalCount | string | no | Specifies whether to return the total number of products. Default value: false | | PageNum | integer | yes | The current page number | | PageSize | integer | no | The number of records per page. Maximum value: 300. Default value: 20 | ### Queries the usage of reserved instances (RIs) `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-riutilization-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | RIInstanceId | string | no | The instance ID of the reserved instance for the filtered query. If this parameter is left empty, the details of all used reserved… | | InstanceSpec | string | no | The instance type corresponding to the reserved instance | | RICommodityCode | string | yes | Valid values: ecsRi: ECS reserved instances. This is the default value. scu_bag: Storage capacity unit (SCU) plans | | DeductedInstanceId | string | no | The ID of the deducted instance. If this parameter is left empty, the details of all instances are returned | | StartTime | string | yes | The start time. Format: YYYY-MM-DD HH:mm:ss | | EndTime | string | yes | The end time. Format: YYYY-MM-DD HH:mm:ss | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 300 | ### Queries the redemption ticket information of a user `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-redeem` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ExpiryTimeStart | string | no | The start time of the expiration period. Format: yyyy-MM-ddTHH:mm:ssZ | | ExpiryTimeEnd | string | no | The end time of the expiration period. Format: yyyy-MM-ddTHH:mm:ssZ | | EffectiveOrNot | string | no | Specifies whether the redemption ticket is effective. Valid values: true: Effective. false: Not effective. Default value: false | | PageNum | integer | no | The page number | | PageSize | integer | no | The number of entries per page. The value cannot exceed 300 | ### Queries the list of member accounts relationships for accounts with master-member relationship permissions `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-relation-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | UserId | integer | yes | The UID of the Alibaba Cloud account | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20 | | StatusList | string | no | The list of relationship statuses. The statuses are enumerated values of RelationshipStatusEnum. If you do not specify this parameter, the… | ### Queries the available quota for a user in a reseller payment scenario `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-reseller-available-quota` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ItemCodes | string | no | You do not need to specify this parameter | ### Queries the low-balance alert rules for quotas `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-reseller-user-alarm-threshold` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | AlarmType | string | no | The alert type. Required. Valid values: quota_low_balance: Quota low-balance alert | ### Queries the instances of a specific resource plan for a user. Only valid resource plans are supported `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-resource-package-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | no | The product code | | ExpiryTimeStart | string | no | The expiration start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC | | ExpiryTimeEnd | string | no | The expiration end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 300 | | IncludePartner | string | no | Specifies whether to include partners | ### Queries the details of savings plan deductions `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-savings-plans-deduct-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | InstanceType | string | no | The query type. Valid values: spn: savings plan instance product: deducted cloud service instance | | PageSize | integer | no | The number of entries per page | | Locale | string | no | The language of the response. Default value: ZH. Valid values: \`ZH\`: Chinese. \`EN\`: English | | PageNum | integer | no | The page number | | InstanceId | string | no | The instance ID | | StartTime | string | no | The beginning of the time range to query | | EndTime | string | no | The end of the time range to query | ### Queries the discount information for savings plans `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-savings-plans-discount` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ModuleCode | string | no | The code of the module | | PayMode | string | yes | The payment mode. Valid values: total: all upfront. half: partial upfront. zero: no upfront | | PageSize | integer | no | The number of entries per page | | SpnType | string | yes | The type of the savings plan. Valid values: ecs: compute-optimized. universal: universal | | Locale | string | no | The language of the response | | Cycle | string | yes | The query cycle | | PageNum | integer | no | The page number | | Spec | string | no | The resource type | | CommodityCode | string | yes | The commodity code | | Region | string | no | The region | | SpnCommodityCode | string | no | The commodity code of the savings plan | ### Queries information about your savings plan instances `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-savings-plans-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | PageSize | integer | no | The number of entries per page | | Locale | string | no | The language of the response. EN: English ZH: Chinese | | PageNum | integer | no | The page number | | InstanceId | string | no | The ID of the savings plan instance | | StartTime | string | no | The start time. The time is in the yyyy-MM-dd HH:mm:ss format | | EndTime | string | no | The end time. The time is in the yyyy-MM-dd HH:mm:ss format | | Tag | string | no | The list of tag elements (JSON-encoded) | | Status | string | no | The status of the instance. Valid values: NORMAL: The instance is active. RELEASE: The instance is released | | CommodityCode | string | no | The commodity code | ### Queries the settlement bills of a user for a specific billing cycle. Supports domestic accounts with more… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-settle-bill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing cycle, in the format of YYYY-MM | | Type | string | no | The type. Valid values: SubscriptionOrder: prepaid order PayAsYouGoBill: pay-as-you-go bill Refund: refund bill Adjustment: adjustment bill | | ProductCode | string | no | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go This parameter must be used together with the… | | IsHideZeroCharge | string | no | Specifies whether to filter based on whether the original price (PretaxGrossAmount) is 0. Default value: false (compatible with existing… | | IsDisplayLocalCurrency | string | no | The IsDisplayLocalCurrency | | NextToken | string | no | The token that marks the position from which the next query starts. Leave this parameter empty to start from the beginning | | MaxResults | integer | no | The maximum number of data records to read in this request. Default value: 20. Maximum value: 300 | | BillOwnerId | integer | no | The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource | | RecordID | string | no | The order ID or bill ID | ### Queries the list of SKUs and their list prices under a specified pricing entity of a commodity. A product… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-sku-price-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | CommodityCode | string | yes | The commodity code. You can call the QueryCommodityList operation to query the commodity code | | PriceEntityCode | string | yes | The pricing entity code. You can call the QueryPriceEntityList operation to query the pricing entity code | | PageSize | integer | yes | The number of entries per page. Maximum value: 50 | | NextPageToken | string | no | The pagination token. Leave this parameter empty for the first page query. The query result returns a token for the next page. An empty… | | PriceFactorConditionMap | string | no | The collection of pricing factor conditions. You can call the QueryPriceEntityList operation to query pricing factor codes and pricing… | | Lang | string | no | The language. Default value: zh (Chinese) | ### Queries split bills. This API has been upgraded. We recommend that you use the new DescribeSplitItemBill… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-split-item-bill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | BillingCycle | string | yes | The billing cycle. Format: YYYY-MM | | ProductCode | string | no | The product code | | ProductType | string | no | The product type | | SubscriptionType | string | no | The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go. Note: This parameter must be used with the… | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 300 | | BillOwnerId | integer | no | The ID of the account that owns the resource. The resource owner is the account that actually uses the resource | ### Queries the metering records for the specified cloud service `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/query-user-oms-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | Table | string | yes | The product and detail information for the usage data, which is typically the ProductCode. Different services support multiple metering… | | DataType | string | yes | The data timestamp type of the metering data. Refer to the specific service documentation for details. Valid values: Raw: hourly Hour:… | | StartTime | string | yes | The start time of the request. The date format must comply with the ISO 8601 standard and use UTC time. Format: yyyy-mm-ddThh:mm:ssZ | | EndTime | string | yes | The end time of the request. The date format must comply with the ISO 8601 standard and use UTC time. Format: yyyy-mm-ddThh:mm:ssZ | | Marker | string | no | The marker that specifies the starting point for returning results in alphabetical order after the NextToken. By default, results are… | | PageSize | integer | no | The number of rows per page for paging in a paged query. Valid values: 1 to 200. Default value: 100 | ### Unsubscribes from an instance that is no longer needed `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/refund-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ClientToken | string | no | Required for idempotent scenarios. A UUID-generated string. This field is used for idempotence. If the same value is passed in multiple… | | ImmediatelyRelease | string | no | Required for unsubscription scenarios. Valid values: 1: immediately releases the instance. 0: stops the instance first based on the… | | ProductCode | string | no | Required for unsubscription scenarios. The product code. If the error code returned after the call indicates that the product is not… | | InstanceId | string | no | Required for unsubscription scenarios. The instance ID, not the custom name | | ProductType | string | no | Required for unsubscription scenarios. The product type. Unless otherwise specified, pass an empty string. In the debugging tool, you do… | ### Releases instances by Virtual Network Operators (VNOs) `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/release-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The code of the service | | SubscriptionType | string | yes | The billing method. Valid values: Subscription: the subscription billing method. PayAsYouGo: the pay-as-you-go billing method | | InstanceIds | string | yes | The ID of the instance. Separate multiple IDs with commas (,). A maximum of 100 IDs can be specified | | RenewStatus | string | no | The method that is used to renew the instance. Valid values: AutoRenewal: automatically renews the instance. ManualRenewal: manually… | | Region | string | no | The region in which the instance resides | | ProductType | string | no | The type of the service | ### Disassociates a RAM user from an Alibaba Cloud account `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/relieve-account-relation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | RelationType | string | no | The relationship type. Only enterprise_group is supported | | ParentUserId | integer | no | The UID of the Alibaba Cloud account. You must specify either the RelationId parameter, or the ParentUserId, ChildUserId, and RelationType… | | ChildUserId | integer | no | The UID of the RAM user. You must specify either the RelationId parameter, or the ParentUserId, ChildUserId, and RelationType parameters | | RequestId | string | yes | The unique ID of the request. This ID is used to troubleshoot issues | | RelationId | integer | no | The ID of the account association. You must specify either the RelationId parameter, or the ParentUserId, ChildUserId, and RelationType… | ### Renews an instance and changes its configuration. The configuration change is applied after the renewal… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/renew-change-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The product code. To obtain it, call QueryProductList | | ProductType | string | no | Product type | | InstanceId | string | yes | The instance ID | | Parameter | string | no | Module list (JSON-encoded) | | ClientToken | string | no | Ensures the idempotence of the request | | RenewPeriod | integer | yes | The subscription renewal duration, in months. Valid values: 1-9 12 24 36 | ### Renews a specified instance. This operation does not support renewing ECS, RDS, or Redis instances. To renew… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/renew-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ProductCode | string | yes | The product code | | InstanceId | string | yes | The instance ID | | RenewPeriod | integer | yes | The renewal period for the subscription instance. Unit: months. Valid values: 1 to 9. 12. 24. 36 | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request | | ProductType | string | no | The product type | ### Renews a resource package instance `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/renew-resource-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the instance | | EffectiveDate | string | no | The time when the resource package takes effect. If you leave this parameter empty, the resource package takes effect immediately. Specify… | | Duration | integer | yes | The renewal duration of the resource package | | PricingCycle | string | yes | The unit of the renewal duration. Valid values: Month Year Default value: Month | ### Sets an expiration date for all Elastic Compute Service (ECS) instances `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/set-all-expiration-day` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | UnifyExpireDay | string | yes | The expiration date. You can set an expiration date only for ECS instances that have not expired. The expiration date that you specify do… | ### Enables auto-renewal for an instance `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/set-renewal` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | RenewalPeriod | integer | no | The auto-renewal period. Valid values: 1 2 3 6 12 This parameter is required if the RenewalStatus parameter is set to AutoRenewal | | InstanceIDs | string | yes | The ID of the instance. You can enable auto-renewal for up to 100 subscription instances at a time. Separate multiple instance IDs with… | | ProductCode | string | yes | The code of the service | | ProductType | string | no | The type of the service | | SubscriptionType | string | no | The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go | | RenewalPeriodUnit | string | no | The unit of the auto-renewal period. Valid values: M: months Y: years This parameter is required if the RenewalStatus parameter is set to… | | RenewalStatus | string | yes | The status of renewal. Valid values: AutoRenewal: The instance is automatically renewed. ManualRenewal: The instance is manually renewed.… | ### Configures low-balance alert rules for quotas `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/set-reseller-user-alarm-threshold` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | AlarmType | string | yes | The alert type. Valid value: quota_low_balance, which indicates a low-balance alert for quotas | | AlarmThresholds | string | no | The list of user alert rules for this alert type. If this parameter is not specified, no alert threshold is set | ### Modify the quota ledger and consumption ledger `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/set-reseller-user-quota` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | Amount | string | yes | The quota of a quota ledger. Unit: CNY | | Currency | string | no | You do not need to set the parameter | | OutBizId | string | no | The ID of the business | ### Enables or disables the SQL audit feature for users `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/set-reseller-user-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | Status | string | yes | The status to set for the user account. Valid values: Freeze: The user account is frozen. Thaw: The user account is restored. Trusteeship:… | | BusinessType | string | yes | The type of business operation. Valid values: FREEZE: Freeze operations. TRUSTEESHIP: Hosting operations | | StopMode | string | no | The stopping mode. Valid values: 0: Normal shutdown. 1: Immediate shutdown | ### Subscribes to bill files by using Object Storage Service (OSS), which stores billing data in a specified OSS… `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/subscribe-bill-to-oss` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | SubscribeBucket | string | yes | The name of the OSS bucket that stores the subscribed bill files | | SubscribeType | string | no | The type of the subscribed bill. Valid values: BillingItemDetailForBillingPeriod: billing item details. InstanceDetailForBillingPeriod:… | | MultAccountRelSubscribe | string | no | For multi-level accounts, specifies the type of bills to push. Valid values: MA: Pushes bills for the primary account and non-trusteeship… | | BucketOwnerId | integer | no | The UID of the OSS owner that stores the files. Specify this parameter if you are a Bid/Reseller subscriber and need to push files to a… | | BeginBillingCycle | string | no | The start billing cycle for pushing. After a successful subscription, the system automatically pushes data from the start billing cycle to… | | BucketPath | string | no | The specified directory under the bucket to which the subscription is delivered | | RowLimitPerFile | integer | no | The maximum number of rows per file. If a bill file exceeds this limit, it is split into multiple files and compressed into a single archive | | UsingSsl | string | no | Specifies whether to use the Secure Sockets Layer (SSL) encryption protocol to protect network communication. Valid values: true: Enables… | ### Adds tags to resources `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ResourceType | string | yes | The resource type. Set the value to instance for savings plan instances | | ResourceId | string | yes | The list of resource IDs (JSON-encoded) | | Tag | string | yes | The list of tags. You can add 1 to 20 tags at a time (JSON-encoded) | ### Cancels a detailed list export subscription `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/unsubscribe-bill-to-oss` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | SubscribeType | string | yes | The subscription type. Valid values: BillingItemDetailForBillingPeriod: billable item-level consumption details.… | | MultAccountRelSubscribe | string | no | For multi-level accounts, specifies the type of bill to push. Valid values: MA: Pushes the bill of the main account. ACP1: Pushes the bill… | ### Removes tags from resources `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/untag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | ResourceType | string | yes | The resource type. Set the value to `instance`. This value indicates a savings plan instance | | All | string | no | Specifies whether to remove all tags. This parameter is valid only when `TagKey.N` is not specified. Valid values: `true` and `false` | | ResourceId | string | yes | The list of resource IDs (JSON-encoded) | | TagKey | string | no | The list of tag keys (JSON-encoded) | ### Upgrades a resource plan `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/upgrade-resource-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the resource plan | | EffectiveDate | string | no | The time when the resource plan takes effect. If you leave this parameter empty, the resource plan immediately takes effect by default.… | | Specification | string | no | The specifications to which you want to upgrade the resource plan | ### version `POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://business.ap-southeast-1.aliyuncs.com | ## Example ``` curl "https://apizie.tech/v1/cloud:aliyun-bssopenapi/add-account-relation" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Alibaba Cloud Billing API? Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-bssopenapi/add-account-relation with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Alibaba Cloud Billing API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Alibaba Cloud Billing itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Alibaba Cloud Billing API? Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-bssopenapi. ### What is the status of the Alibaba Cloud Alibaba Cloud Billing API? Needs your own provider key (bring your own key)