All Products
Search

This Product

    Expenses and Costs:QueryBillToOSSSubscription

    Document Center

    Expenses and Costs:QueryBillToOSSSubscription

    Last Updated:Aug 28, 2026

    Queries bill subscriptions stored in an Object Storage Service (OSS) bucket.

    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

    bss:DescribeSubscribeToOSS

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The status code.

    Success
    Message

    string

    The message returned.

    Successful!
    RequestId

    string

    The request ID.

    9EEAE43F-1E4D-4734-AE93-5049878AC103
    Success

    boolean

    Indicates whether the request was successful.

    true
    Data

    object

    The returned data.

    AccountName

    string

    The account name used for the query.

    test@test.aliyunid.com
    AccountID

    string

    The account ID used for the query.

    185xxxxx03489
    Items

    object

    Item

    array<object>

    The details of the subscribed bill.

    object

    The details of the subscribed bill.

    BucketOwnerId

    integer

    The owner ID of the OSS bucket.

    1369168081849304
    SubscribeType

    string

    The type of the subscribed bill. Valid values:

    • BillingItemDetailForBillingPeriod: the bill of a billable item.

    • InstanceDetailForBillingPeriod: the bill of an instance.

    BillingItemDetailForBillingPeriod
    SubscribeBucket

    string

    The ID of the OSS bucket that stores the subscribed bill.

    billingtestbucket
    SubscribeTime

    string

    The time when the bill was stored in the OSS bucket, in the YYYY-MM-DD hh:mm:ss format.

    2019-10-30 15:40:11
    SubscribeLanguage

    string

    The language code.

    Valid values:

    • en: English

    • zh: Chinese

    Valid values:

    • en :

    • zh :

    zh
    BucketPath

    string

    The path in the OSS bucket.

    Billing/BillingItemDetailMonthly/
    RowLimitPerFile

    integer

    The maximum number of data rows in a single file. If the number of rows exceeds this limit, the bill is split into multiple files, which are then merged and compressed into a package.

    300000

    Examples

    Success response

    JSON format

    {
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "9EEAE43F-1E4D-4734-AE93-5049878AC103",
  "Success": true,
  "Data": {
    "AccountName": "test@test.aliyunid.com",
    "AccountID": "185xxxxx03489",
    "Items": {
      "Item": [
        {
          "BucketOwnerId": 1369168081849304,
          "SubscribeType": "BillingItemDetailForBillingPeriod",
          "SubscribeBucket": "billingtestbucket",
          "SubscribeTime": "2019-10-30 15:40:11",
          "SubscribeLanguage": "zh",
          "BucketPath": "Billing/BillingItemDetailMonthly/",
          "RowLimitPerFile": 300000
        }
      ]
    }
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.