获取合同包列表

获取合同包列表

Query Parameters

sku_id string

规格ID

effective_state string

生效状态 待生效 FUTURE 、有效 VALID、失效 EXPIRED

filter string

筛选条件 支持 合同包ID/编号/名称 例如： start_date>='2024-01-08T16:00:00Z' AND end_date<='2024-01-18T15:59:59Z' AND display_name="1"

order_by string

排序

page_size int32

分页大小

page_token string

分页页码

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

contracts object[]
合同包列表
Array [
display_name string required
合同包名称
type string
合同包类型，CT_ORIGINAL 原始、CT_ADDITIONAL 补充
original_id string
补充合同包的原始合同包ID，默认为空
contract_no string required
线下合同编号
contract_name string required
线下合同名称
original_amount int64
原价（目录价）
amount int64 required
金额，合同价（成交价）
sku_amount_money object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
user_amount_money object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
state enum
Possible values: [PENDING, COMMITTED, DELIVERED, CONSIGN, TERMINATE]
状态
start_date_time date-time required
有效期-开始日期
end_date_time date-time required
有效期-结束日期
tenant_id string required
租户 UUID
details object[] required
商品明细信息
Array [
sku_id string required
sku object
最小库存单元
spu_id string required
隶属标准化产品单元id
display_name string required
最小库存单元名称
regions string[] required
可售卖区域
available_zones string[] required
可售卖可用区
business_billing_cycle enum required
Possible values: [BBC_UNSPECIFIED, BBC_HOURLY, BBC_DAILY, BBC_WEEKLY, BBC_MONTHLY, BBC_QUARTERLY, BBC_YEARLY]
计费周期， 默认每小时;
billing_cycle enum required
Possible values: [BC_UNSPECIFIED, BC_HOURLY, BC_DAILY, BC_WEEKLY, BC_MONTHLY, BC_QUARTERLY, BC_YEARLY]
账单周期， 默认按月出账;
billing_cycle_number int32 required
账单周期数
payment_model enum required
Possible values: [PM_UNSPECIFIED, PM_PREPAID, PM_POSTPAID]
付费模式
billing_model enum required
Possible values: [BM_UNSPECIFIED, BM_USAGE, BM_MONTHLY, BM_YEARLY]
计费模式
price_model enum required
Possible values: [PIM_UNSPECIFIED, PIM_FLATFEE, PIM_PERUNIT, PIM_TIERED, PIM_VOLUME, PIM_STAIRSTEP]
计费模型
price object[] required
价格
Array [
tier int32
层次
name string
层次名称
max_value int64
每层最大值
money object[]
价格
Array [
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
]
price_unit string required
价格单位
price_scale int64 required
价格上报尺度
stock int64 required
库存数量
stock_unit string required
库存单位
discount int32 required
折扣, 从0-100, 100表示不打折
max_quantity int64
最多可售卖数量
min_quantity int64
最少可售卖数量
have_trial boolean
是否含有试用期
trial_count int64
试用数量
trial_unit string
试用单位
effective_time date-time required
生效时间(已弃用)
ineffective_time date-time required
失效时间(已弃用)
one_time boolean
是否只能购买一次
cancel_policy enum
Possible values: [SP_UNSPECIFIED, SP_IMMEDIATELY, SP_ENDOFTERM, SP_UNCONDITIONALLY_REFUND, SP_NONREFUNDABLE]
退订规则
actions string[]
此字段已弃用
tags string[]
此字段已弃用
excess_sku_id string
此字段已弃用
attributes object[]
关联的规格和描述属性
Array [
attribute_id string
属性id
display_name string
属性名称
property_name string
属性后端名称
value string
属性值
value_unit string
属性单位
value_scale int64
value scale
attribute_value_id string
属性值id
attribute_type enum
Possible values: [ATT_KEY, ATT_SPEC, ATT_DESCRIPTION, ATT_BILLING_ITEM]
属性类型
]
sku_billing_items object[] required
关联的计费项
Array [
id string required
计费项id
sku_id string required
最小库存单元id
attribute_id string required
关联计费属性id
value_unit string required
属性单位
price_model enum required
Possible values: [PIM_UNSPECIFIED, PIM_FLATFEE, PIM_PERUNIT, PIM_TIERED, PIM_VOLUME, PIM_STAIRSTEP]
价格模型
price object[] required
价格
Array [
tier int32
层次
name string
层次名称
max_value int64
每层最大值
money object[]
价格
Array [
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
]
price_unit string required
价格单位
price_scale int64 required
价格尺度
stock int64 required
库存
stock_unit string required
库存单位
max_quantity int64 required
计费项数量上限
min_quantity int64 required
计费项数量下限
value_scales object[]
单位换算关系
Array [
value_unit string
属性单位
value_scale int64
换算倍数
attribute_value_id string
属性值id
]
status enum required
Possible values: [ST_UNSPECIFIED, ST_RELEASE, ST_UNRELEASED]
状态
discount int32 required
折扣
meter_unit string required
计量上报单位
]
meter_unit string required
计量上报单位
usage_scope_type enum
Possible values: [UST_UST_UNSPECIFIED, UST_PUBLIC, UST_SPECIFIED]
适用类型
usage_scope_tenant_ids string[]
适用租户IDs
usage_scope_editable boolean
适用是否可编辑
spu_id string required
region string required
zone string required
number int32 required
billing_items object[]
Array [
billing_item_id string required
billing_item_key string required
value int64 required
value_unit string required
sku_billing_item object
计费项
id string required
计费项id
sku_id string required
最小库存单元id
attribute_id string required
关联计费属性id
value_unit string required
属性单位
price_model enum required
Possible values: [PIM_UNSPECIFIED, PIM_FLATFEE, PIM_PERUNIT, PIM_TIERED, PIM_VOLUME, PIM_STAIRSTEP]
价格模型
price object[] required
价格
Array [
tier int32
层次
name string
层次名称
max_value int64
每层最大值
money object[]
价格
Array [
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
]
price_unit string required
价格单位
price_scale int64 required
价格尺度
stock int64 required
库存
stock_unit string required
库存单位
max_quantity int64 required
计费项数量上限
min_quantity int64 required
计费项数量下限
value_scales object[]
单位换算关系
Array [
value_unit string
属性单位
value_scale int64
换算倍数
attribute_value_id string
属性值id
]
status enum required
Possible values: [ST_UNSPECIFIED, ST_RELEASE, ST_UNRELEASED]
状态
discount int32 required
折扣
meter_unit string required
计量上报单位
user_amount int64 required
成交价
]
user_amount int64 required
成交价
length int32 required
购买时长，仅用于计算合同包参考价格
]
contract_proof string
合同凭证
]
next_page_token string

下一页页码

total_size int32

总记录数

page_number int32

当前页码

page_size int32

分页大小

{
  "contracts": [
    {
      "id": "string",
      "display_name": "string",
      "type": "string",
      "original_id": "string",
      "contract_no": "string",
      "contract_name": "string",
      "original_amount": 0,
      "amount": 0,
      "sku_amount_money": {
        "currency_code": "string",
        "units": 0,
        "nanos": 0
      },
      "user_amount_money": {
        "currency_code": "string",
        "units": 0,
        "nanos": 0
      },
      "state": "PENDING",
      "start_date_time": "2024-11-04T06:28:48.805Z",
      "end_date_time": "2024-11-04T06:28:48.805Z",
      "tenant_id": "string",
      "tenant_name": "string",
      "tenant_code": "string",
      "customer_type": "string",
      "details": [
        {
          "id": "string",
          "contract_id": "string",
          "sku_id": "string",
          "sku_name": "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": "2024-11-04T06:28:48.806Z",
            "ineffective_time": "2024-11-04T06:28:48.806Z",
            "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": "2024-11-04T06:28:48.806Z",
                "update_time": "2024-11-04T06:28:48.806Z",
                "meter_unit": "string"
              }
            ],
            "creator": "string",
            "updater": "string",
            "create_time": "2024-11-04T06:28:48.806Z",
            "update_time": "2024-11-04T06:28:48.806Z",
            "meter_unit": "string",
            "usage_scope_type": "UST_UST_UNSPECIFIED",
            "usage_scope_tenant_ids": [
              "string"
            ],
            "usage_scope_editable": true
          },
          "spu_id": "string",
          "spu_name": "string",
          "resource_type": "string",
          "region": "string",
          "zone": "string",
          "number": 0,
          "available_number": 0,
          "billing_items": [
            {
              "id": "string",
              "contract_detail_id": "string",
              "billing_item_id": "string",
              "billing_item_key": "string",
              "billing_item_name": "string",
              "value": 0,
              "available_value": 0,
              "value_unit": "string",
              "sku_id": "string",
              "sku_billing_item": {
                "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": "2024-11-04T06:28:48.806Z",
                "update_time": "2024-11-04T06:28:48.806Z",
                "meter_unit": "string"
              },
              "amount": 0,
              "user_amount": 0,
              "creator": "string",
              "updater": "string",
              "create_time": "2024-11-04T06:28:48.806Z",
              "update_time": "2024-11-04T06:28:48.806Z",
              "creator_name": "string",
              "updater_name": "string"
            }
          ],
          "amount": 0,
          "user_amount": 0,
          "length": 0,
          "creator": "string",
          "updater": "string",
          "create_time": "2024-11-04T06:28:48.806Z",
          "update_time": "2024-11-04T06:28:48.806Z",
          "creator_name": "string",
          "updater_name": "string",
          "start_time": "2024-11-04T06:28:48.806Z",
          "end_time": "2024-11-04T06:28:48.806Z"
        }
      ],
      "contract_proof": "string",
      "contract_proof_count": 0,
      "additional_count": 0,
      "effective_state": "FUTURE",
      "creator": "string",
      "updater": "string",
      "create_time": "2024-11-04T06:28:48.806Z",
      "update_time": "2024-11-04T06:28:48.806Z",
      "creator_name": "string",
      "updater_name": "string",
      "contract_version": "V1"
    }
  ],
  "next_page_token": "string",
  "total_size": 0,
  "page_number": 0,
  "page_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[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...