DocsICP FilingConsole
Documentation

DescribeProductAmortizedCostByAmortizationPeriod

Updated at:
Copy as MD
My Favorites

Queries the monthly amortized costs of products from the perspective of the amortization month.

Operation description

  • Amortized costs are not used as the basis for settlement and reconciliation. Amortized costs provide the cost allocation capability, which allocates the costs incurred on the cloud (including prepaid and pay-as-you-go costs) based on specified allocation rules.

  • The final data for the current month is available after 12:00 on the 6th day of the next month. During the month, a few scenarios may occur, including but not limited to delayed billing, refunds, account adjustments, and overdue payment write-offs. The data for the current month does not include unsettled pay-as-you-go data (unbilled or being accumulated).

  • Amortized cost data is available for the last 12 months.

  • Data related to attached resources in amortized costs is updated 48 hours after the split bill data is generated. If you need to use the costs of attached resources, activate Split Bill in advance. Data not related to attached resources is updated 48 hours after the detailed bill is generated.

  • Amortized costs before August 2021 (exclusive) are not updated during the month. They are updated uniformly only after 12:00 on the 6th day of the next amortization month. Specific costs for each attached resource (such as domain names, buckets, and EIPs) of cloud products that support split billing (such as CDN, OSS, and Internet Shared Bandwidth) are not supported.

  • Amortized cost data is available only after you activate Amortized Costs. The data is available 48 hours after activation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bssapi:DescribeCostBill

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
BillingCycle

string

Yes

The amortization month. Format: YYYY-MM.

2022-10
ConsumePeriodFilter

array

No

The filter condition for the billing month. Maximum number of elements: 10.

string

No

The billing month. Format: YYYY-MM.

2022-09
SubscriptionType

string

No

The subscription type. Valid values:

  • Subscription: subscription.

  • PayAsYouGo: pay-as-you-go.

Subscription
ProductCode

string

No

The product code. Reference value sources: Call QueryProductList to query product information, or call DescribeResourcePackageProduct to query the information about a specific resource plan product.

rds
ProductDetail

string

No

The product detail.

rds
CostUnitCode

string

No

The code of the financial unit.

123#

BillUserIdList

array

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 Cloud. If you do not specify this parameter, the bills of the current caller account and all its RAM users are viewed by default. Maximum number of elements: 10.

string

No

The bill purchaser ID.

123
BillOwnerIdList

array

No

The filter condition for the resource ownership account. The ID of the resource ownership account. The resource ownership account is the account that actually uses the resources. Maximum number of elements: 10.

string

No

The resource ownership account ID.

abc
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 returned in the previous response. Otherwise, an error is reported. An empty value indicates that the reading starts from the beginning.

CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U
MaxResults

integer

No

The maximum number of data records to return in the current call. Default value: 20. Maximum value: 300.

20

Response elements

Element

Type

Description

Example

object

BssResult

Code

string

The status code.

200

Data

object

The returned data.

AccountID

string

The account ID.

185766xxxx
AccountName

string

The user account.

test@test.aliyunid.com

Items

array<object>

The data entries.

object

The data item.

AfterDiscountAmount

number

The amount after discount.

0
AmortizationPeriod

string

The amortization month. Format: YYYYMM.

202210
AmortizationStatus

string

The amortization status. Valid values:

  • amortized: amortized.

  • unAmortized: unamortized.

amortized
BillAccountID

integer

The ID of the account to which the bill belongs.

185xxxxx489
BillAccountName

string

The name of the account to which the bill belongs.

test@test.aliyunid.com

BillOwnerID

integer

The resource ownership account ID.

185xxxxx489
BillOwnerName

string

The name of the account to which the resources belong.

test@test.aliyunid.com

BizType

string

The business type.

trusteeship

ConsumePeriod

string

The billing cycle. Format: YYYYMM.

202210
CurrentAmortizationAfterDiscountAmount

number

The current amortization amount after discount.

0
CurrentAmortizationDeductedByCashCoupons

number

The current amortization amount deducted by vouchers.

0
CurrentAmortizationDeductedByCoupons

number

The current amortization amount deducted by coupons.

0
CurrentAmortizationDeductedByPrepaidCard

number

The current amortization amount paid by prepaid cards.

0
CurrentAmortizationExpenditureAmount

number

The current amortization expenditure amount (invoiceable).

0
CurrentAmortizationInvoiceDiscount

number

The current amortization invoice discount amount.

0
CurrentAmortizationPretaxAmount

number

The current amortization pretax amount.

0
CurrentAmortizationPretaxGrossAmount

number

The current amortization pretax gross amount.

0
CurrentAmortizationRoundDownDiscount

number

The current amortization round-down discount amount.

0
DeductedByCashCoupons

number

The amount deducted by vouchers.

0
DeductedByCoupons

number

The amount deducted by coupons.

0
DeductedByPrepaidCard

number

The amount paid by prepaid cards.

0
ExpenditureAmount

number

The expenditure amount (invoiceable).

0
InvoiceDiscount

number

The invoice discount amount.

0
PretaxAmount

number

The pretax amount.

0
PretaxGrossAmount

number

The pretax gross amount.

0
PreviouslyAmortizedAfterDiscountAmount

number

The previously amortized amount after discount.

0
PreviouslyAmortizedDeductedByCashCoupons

number

The previously amortized amount deducted by vouchers.

0
PreviouslyAmortizedDeductedByCoupons

number

The previously amortized amount deducted by coupons.

0
PreviouslyAmortizedDeductedByPrepaidCard

number

The previously amortized amount paid by prepaid cards.

0
PreviouslyAmortizedExpenditureAmount

number

The previously amortized expenditure amount (invoiceable).

0
PreviouslyAmortizedInvoiceDiscount

number

The previously amortized invoice discount amount.

0
PreviouslyAmortizedPretaxAmount

number

The previously amortized pretax amount.

0
PreviouslyAmortizedPretaxGrossAmount

number

The previously amortized pretax gross amount.

0
PreviouslyAmortizedRoundDownDiscount

number

The previously amortized round-down discount amount.

0
ProductCode

string

The product code.

rds
ProductDetail

string

The product detail.

ApsaraDB RDS
ProductDetailCode

string

The product detail code.

rds
ProductName

string

The product name.

ApsaraDB RDS
RemainingAmortizationAfterDiscountAmount

number

The remaining amortization amount after discount.

0
RemainingAmortizationDeductedByCashCoupons

number

The remaining amortization amount deducted by vouchers.

0
RemainingAmortizationDeductedByCoupons

number

The remaining amortization amount deducted by coupons.

0
RemainingAmortizationDeductedByPrepaidCard

number

The remaining amortization amount paid by prepaid cards.

0
RemainingAmortizationExpenditureAmount

number

The remaining amortization expenditure amount (invoiceable).

0
RemainingAmortizationInvoiceDiscount

number

The remaining amortization invoice discount amount.

0
RemainingAmortizationPretaxAmount

number

The remaining amortization pretax amount.

0
RemainingAmortizationPretaxGrossAmount

number

The remaining amortization pretax gross amount.

0
RemainingAmortizationRoundDownDiscount

number

The remaining amortization round-down discount amount.

0
RoundDownDiscount

number

The round-down discount amount.

0
SubscriptionType

string

The subscription type. Valid values:

  • Subscription: subscription.

  • PayAsYouGo: pay-as-you-go.

PayAsYouGo
MaxResults

integer

The maximum number of records returned for the current request.

100
NextToken

string

The token that specifies the position from which the current call starts reading. The value must be empty or set to the NextToken value returned in the previous response. Otherwise, an error is reported. An empty value indicates that the reading starts from the beginning.

CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U

TotalCount

integer

The total number of records.

100
Message

string

The message description.

Successful！

RequestId

string

The request ID.

79EE7556-0CFD-44EB-9CD6-B3B526E3A85F

Success

boolean

Indicates whether the request is successful.

true

Examples

Success response

JSON format

{
  "Code": "200\n",
  "Data": {
    "AccountID": "185766xxxx",
    "AccountName": "test@test.aliyunid.com\n",
    "Items": [
      {
        "AfterDiscountAmount": 0,
        "AmortizationPeriod": "202210",
        "AmortizationStatus": "amortized",
        "BillAccountID": 0,
        "BillAccountName": "test@test.aliyunid.com\n",
        "BillOwnerID": 0,
        "BillOwnerName": "test@test.aliyunid.com\n",
        "BizType": "trusteeship\n",
        "ConsumePeriod": "202210",
        "CurrentAmortizationAfterDiscountAmount": 0,
        "CurrentAmortizationDeductedByCashCoupons": 0,
        "CurrentAmortizationDeductedByCoupons": 0,
        "CurrentAmortizationDeductedByPrepaidCard": 0,
        "CurrentAmortizationExpenditureAmount": 0,
        "CurrentAmortizationInvoiceDiscount": 0,
        "CurrentAmortizationPretaxAmount": 0,
        "CurrentAmortizationPretaxGrossAmount": 0,
        "CurrentAmortizationRoundDownDiscount": 0,
        "DeductedByCashCoupons": 0,
        "DeductedByCoupons": 0,
        "DeductedByPrepaidCard": 0,
        "ExpenditureAmount": 0,
        "InvoiceDiscount": 0,
        "PretaxAmount": 0,
        "PretaxGrossAmount": 0,
        "PreviouslyAmortizedAfterDiscountAmount": 0,
        "PreviouslyAmortizedDeductedByCashCoupons": 0,
        "PreviouslyAmortizedDeductedByCoupons": 0,
        "PreviouslyAmortizedDeductedByPrepaidCard": 0,
        "PreviouslyAmortizedExpenditureAmount": 0,
        "PreviouslyAmortizedInvoiceDiscount": 0,
        "PreviouslyAmortizedPretaxAmount": 0,
        "PreviouslyAmortizedPretaxGrossAmount": 0,
        "PreviouslyAmortizedRoundDownDiscount": 0,
        "ProductCode": "rds",
        "ProductDetail": "云数据库RDS\n",
        "ProductDetailCode": "rds",
        "ProductName": "云数据库RDS\n",
        "RemainingAmortizationAfterDiscountAmount": 0,
        "RemainingAmortizationDeductedByCashCoupons": 0,
        "RemainingAmortizationDeductedByCoupons": 0,
        "RemainingAmortizationDeductedByPrepaidCard": 0,
        "RemainingAmortizationExpenditureAmount": 0,
        "RemainingAmortizationInvoiceDiscount": 0,
        "RemainingAmortizationPretaxAmount": 0,
        "RemainingAmortizationPretaxGrossAmount": 0,
        "RemainingAmortizationRoundDownDiscount": 0,
        "RoundDownDiscount": 0,
        "SubscriptionType": "PayAsYouGo"
      }
    ],
    "MaxResults": 100,
    "NextToken": "CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U\n",
    "TotalCount": 100
  },
  "Message": "Successful！\n",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\n",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description
400 NotActiveService You are not active Amotized Cost ，please use after activation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.