All Products
Search

This Product

    Expenses and Costs:QueryBillToOSSSubscription

    Document Center

    Expenses and Costs:QueryBillToOSSSubscription

    Last Updated:Sep 10, 2026

    Queries the records of bill subscriptions to OSS buckets.

    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
    Data

    object

    The returned data.

    AccountID

    string

    The ID of the current query account.

    185xxxxx03489
    AccountName

    string

    The name of the current query account.

    test@test.aliyunid.com
    Items

    object

    Item

    array<object>

    The subscription details.

    object

    The subscription details.

    BucketOwnerId

    integer

    The user ID of the bucket owner.

    1369168081849304
    BucketPath

    string

    The OSS storage directory.

    Billing/BillingItemDetailMonthly/
    RowLimitPerFile

    integer

    The maximum number of rows per file. If a bill file exceeds this limit, it is split into multiple files and merged into a compressed package.

    300000
    SubscribeBucket

    string

    The ID of the subscribed bucket.

    billingtestbucket
    SubscribeLanguage

    string

    The language code of the subscription. Valid values:

    • en: English.

    • zh: Chinese.

    Valid values:

    • en :

      English.

    • zh :

      Chinese.

    zh
    SubscribeTime

    string

    The subscription time in the format of 'YYYY-MM-DD hh:mm:ss'.

    2019-10-30 15:40:11
    SubscribeType

    string

    The subscribed bill type. Valid values:

    • BillingItemDetailForBillingPeriod: Billing item consumption details.

    • InstanceDetailForBillingPeriod: Instance consumption details.

    BillingItemDetailForBillingPeriod
    Message

    string

    The error message.

    Successful!
    RequestId

    string

    The request ID.

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

    boolean

    Indicates whether the request was successful.

    true

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.