获取订单列表
获取订单列表
Query Parameters
filter string
列表筛选条件 支持用户名、订单编号、产品服务 订单开始/结束日期筛选,如:creator_name="xue" AND id="67" AND create_time>="2023-12-01" AND create_time<="2024-02-01"
order_by string
排序结果
page_size int32
返回当前页的最大条目数
page_token string
从上一个List请求返回的next_page_token值
resource_instance_id string
资源实例 uuid
resource_type string[]
资源类型
contract_display_name string
资源包/合同包名称
resource_name string
资源标识
resource_display_name string
资源名称
Responses
- 200
- default
OK
application/json
Schema
Example (from schema)
Schema
orders object[] required
next_page_token string
下一页
total_size int32
总记录
{
"orders": [
{
"id": "string",
"subscription_id": "string",
"resource_group_id": "string",
"subscription_name": "string",
"resource_group_name": "string",
"spu_name": "string",
"billing_day": 0,
"state": "OS_UNSPECIFIED",
"type": "OT_UNSPECIFIED",
"start_time": "2025-05-20T07:01:06.970Z",
"end_time": "2025-05-20T07:01:06.970Z",
"auto_renew": true,
"change_policy": "SP_UNSPECIFIED",
"cancel_policy": "SP_UNSPECIFIED",
"original_id": "string",
"contract_display_name": "string",
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"original_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"discount_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"coupon_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"voucher_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"pay": "PC_UNSPECIFIED",
"note": "string",
"currency_code": "string",
"creator": "string",
"updater": "string",
"create_time": "2025-05-20T07:01:06.970Z",
"update_time": "2025-05-20T07:01:06.970Z",
"details": [
{
"id": "string",
"order_id": "string",
"sku": {
"spu_id": "string",
"id": "string",
"display_name": "string",
"regions": [
"string"
],
"available_zones": [
"string"
],
"business_billing_cycle": "BBC_UNSPECIFIED",
"billing_cycle": "BC_UNSPECIFIED",
"billing_cycle_number": 0,
"payment_model": "PM_UNSPECIFIED",
"billing_model": "BM_UNSPECIFIED",
"price_model": "PIM_UNSPECIFIED",
"price": [
{
"tier": 0,
"name": "string",
"max_value": 0,
"money": [
{
"currency_code": "string",
"units": 0,
"nanos": 0
}
]
}
],
"price_unit": "string",
"price_scale": 0,
"stock": 0,
"stock_unit": "string",
"discount": 0,
"max_quantity": 0,
"min_quantity": 0,
"have_trial": true,
"trial_count": 0,
"trial_unit": "string",
"effective_time": "2025-05-20T07:01:06.971Z",
"ineffective_time": "2025-05-20T07:01:06.971Z",
"one_time": true,
"cancel_policy": "SP_UNSPECIFIED",
"actions": [
"string"
],
"tags": [
"string"
],
"excess_sku_id": "string",
"attributes": [
{
"attribute_id": "string",
"display_name": "string",
"property_name": "string",
"value": "string",
"value_unit": "string",
"value_scale": 0,
"attribute_value_id": "string",
"attribute_type": "ATT_KEY"
}
],
"status": "ST_UNSPECIFIED",
"spu_name": "string",
"sku_billing_items": [
{
"id": "string",
"sku_id": "string",
"attribute_id": "string",
"display_name": "string",
"property_name": "string",
"value_unit": "string",
"price_model": "PIM_UNSPECIFIED",
"price": [
{
"tier": 0,
"name": "string",
"max_value": 0,
"money": [
{
"currency_code": "string",
"units": 0,
"nanos": 0
}
]
}
],
"price_unit": "string",
"price_scale": 0,
"stock": 0,
"stock_unit": "string",
"max_quantity": 0,
"min_quantity": 0,
"value_scales": [
{
"value_unit": "string",
"value_scale": 0,
"attribute_value_id": "string"
}
],
"status": "ST_UNSPECIFIED",
"discount": 0,
"creator": "string",
"updater": "string",
"create_time": "2025-05-20T07:01:06.971Z",
"update_time": "2025-05-20T07:01:06.971Z",
"meter_unit": "string"
}
],
"creator": "string",
"updater": "string",
"create_time": "2025-05-20T07:01:06.971Z",
"update_time": "2025-05-20T07:01:06.971Z",
"meter_unit": "string",
"usage_scope_type": "UST_UST_UNSPECIFIED",
"usage_scope_tenant_ids": [
"string"
],
"usage_scope_editable": true
},
"order_billing_items": [
{
"id": "string",
"billing_item_id": "string",
"number": 0,
"property_name": "string",
"display_name": "string",
"price_scale": 0,
"price_model": "PIM_UNSPECIFIED",
"price": [
{
"tier": 0,
"name": "string",
"max_value": 0,
"money": [
{
"currency_code": "string",
"units": 0,
"nanos": 0
}
]
}
],
"discount": 0,
"value_unit": "string",
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"original_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"discount_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
}
}
],
"region_code": "string",
"zone": "string",
"currency_code": "string",
"payment_model": "PM_UNSPECIFIED",
"price": [
{
"tier": 0,
"name": "string",
"max_value": 0,
"money": [
{
"currency_code": "string",
"units": 0,
"nanos": 0
}
]
}
],
"number": 0,
"billing_cycle": 0,
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"original_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"discount_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"coupon_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"voucher_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"free_quantity": 0,
"state": "OD_UNSPECIFIED",
"active_time": "2025-05-20T07:01:06.971Z",
"contract_detail_id": "string",
"creator": "string",
"updater": "string",
"create_time": "2025-05-20T07:01:06.971Z",
"update_time": "2025-05-20T07:01:06.971Z",
"instances": [
{
"id": "string",
"resource_instance_id": "string",
"resource_instance_rid": "string",
"order_detail_id": "string",
"start_time": "2025-05-20T07:01:06.971Z",
"end_time": "2025-05-20T07:01:06.971Z",
"subscription_name": "string",
"resource_group_name": "string",
"name": "string",
"display_name": "string"
}
],
"spu_name": "string",
"fulfill_rm_resource_row": "string",
"fulfill_rm_message_body": "string",
"fulfill_rm_topic": "string",
"meter_rules": [
{
"id": "string",
"order_detail_id": "string",
"tier": 0,
"max_value": 0,
"price": 0
}
],
"resource_type": "string",
"properties": {
"@type": "string"
}
}
],
"name": "string",
"creator_name": "string",
"unsubscription_reason": "string",
"cancel_renew_flag": true,
"initial_id": "string",
"transferred_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"resource_diff_value": "string",
"ba_departed_amounts": [
{
"billing_account_display_name": "string",
"billing_account_id": "string",
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"currency_code": "string",
"depart_ratio": 0,
"trans_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"refund_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"original_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
}
}
],
"contract_ver": "string",
"auto_convert_postpaid": true,
"ba_recommend_voucher_instances": [
{
"billing_account_id": "string",
"recommend_voucher_instance": [
{
"voucher_instance": {
"voucher_batch_id": "string",
"id": "string",
"display_name": "string",
"voucher_issue_id": "string",
"billing_account_id": "string",
"billing_account_name": "string",
"tenant_id": "string",
"tenant_code": "string",
"tenant_display_name": "string",
"issue_comment": "string",
"voucher_type": "VT_DISCOUNT",
"use_scope": "US_GENERAL",
"use_case": "UC_GENERAL",
"use_count": "UC_SINGLE",
"use_limit": "UL_NO_THRESHOLD",
"prepaid_limit": "PL_OVERLAY",
"postpaid_limit": "PL_UNSPECIFIED",
"max_deductible_ratio": 0,
"reachable_amount": 0,
"max_amount_monthly": 0,
"backend_catalog_id": "string",
"backend_catalog_name": "string",
"backend_catalogs": [
{
"id": "string",
"display_name": "string",
"parent_id": "string",
"is_leaf": true,
"level": 0,
"order": 0,
"enable": true,
"url": "string",
"buy_url": "string",
"resource_types": [
"string"
],
"have_descendants": true,
"backend_catalog_code": "string",
"creator": "string",
"updater": "string",
"create_time": "2025-05-20T07:01:06.972Z",
"update_time": "2025-05-20T07:01:06.972Z",
"is_favorite": true,
"icon": "string",
"tags": [
"string"
],
"introduction": "string",
"official_link": "string",
"help_link": "string",
"recommended_catalogs": [
"string"
],
"has_resource": true,
"saleable": true,
"icon_code": "string",
"gray_release": true,
"tenant_whitelist": [
"string"
],
"favorite_time": "2025-05-20T07:01:06.972Z",
"resource_type_group_ids": [
"string"
],
"usage_scope_type": "UST_UST_UNSPECIFIED",
"usage_scope_tenant_ids": [
"string"
],
"usage_scope_editable": true
}
],
"denomination_value": 0,
"available_value": 0,
"denomination_money": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"available_money": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"effective_time": "2025-05-20T07:01:06.972Z",
"ineffective_time": "2025-05-20T07:01:06.972Z",
"state": "STATE_UNUSED",
"issuer_name": "string",
"creator": "string",
"updater": "string",
"create_time": "2025-05-20T07:01:06.972Z",
"update_time": "2025-05-20T07:01:06.972Z",
"creator_name": "string",
"updater_name": "string",
"recent_consumption_time": "2025-05-20T07:01:06.972Z",
"voucher_intance_transactions": [
{
"id": "string",
"related_object_type": "TXROT_UNSPECIFIED",
"action": "TXI_UNSPECIFIED",
"related_object_id": "string",
"bill_month": "string",
"consumption_time": "2025-05-20T07:01:06.973Z",
"voucher_instance_id": "string",
"billing_account_id": "string",
"amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"available_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
}
}
]
},
"system_recommend": true,
"deduction_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"max_deduction_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"remaining_amount": {
"currency_code": "string",
"units": 0,
"nanos": 0
}
}
]
}
]
}
],
"next_page_token": "string",
"total_size": 0
}
Default error response
application/json
Schema
Example (from schema)
Schema
code int32
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
message string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
GET /v1/orders
Authorization
name: bearerAuthtype: httpscheme: bearer
Request
Request
curl / cURL
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
python / requests
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
go / native
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
nodejs / axios
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
ruby / Net::HTTP
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
csharp / RestSharp
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
php / cURL
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
java / OkHttp
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
powershell / RestMethod
curl -L -X GET 'https://finance.sensecoreapi.cn/boss/subscription/v1/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'