GetCustomerContractsListResponseModel

statusboolean

Whether the request succeeded.

Example: true

messagestring

Human-readable description of the result.

Example: Getting customer contracts list successful

contracts object[]

Customer contracts on the account.

Array [

idinteger

Unique numeric identifier.

org_idinteger

Identifier of the organization that owns the resource.

descriptionstring

Human-readable description of the resource.

start_datestring<date-time>

Inclusive start of the time window. ISO 8601 with T separator and time component (for example, 2026-05-01T00:00:00).

end_datestring<date-time>

Exclusive end of the time window. Same format as start_date.

expiration_policyinteger

The expiration policy for the contract is represented by a value of 0, indicating that contracted resources will be deleted upon contract expiration, or 1, indicating that contracted resources will be retained, with billing continuing at market rates.

statusstring

Current lifecycle state of the resource.

discounts object[]

An array of objects containing information about discounts applied to each resource type associated with the contract.

Array [

idinteger

Unique numeric identifier.

resource_idinteger

Identifier of the resource the entry refers to.

resource_namestring

Name of the resource the entry refers to.

resource_countinteger

The number of resources that the discount is applied to.

discount_typestring

The type of discount applied to the resource can be represented as either flat or percent. For flat discount type, the actual price of the discounted resource is specified, while for percent discount type, a percentage discount is applied to the market rate for the resource.

discount_codestring

The discount code applied to the resource, if applicable.

discount_percentnumber

If the discount_type used is percent, this specifies the percentage discount to be applied to the market rate for a given resource.

discount_amountnumber

Amount discounted from the non-discounted bill.

discount_statusstring

The status of the discount (e.g., "active").

remaining_countinteger

]

created_atstring<date-time>

ISO 8601 UTC timestamp marking when the resource was created.

]

countinteger

Number of items returned in the current page.

Example: 0

GetCustomerContractsListResponseModel

{
  "status": true,
  "message": "Getting customer contracts list successful",
  "contracts": [
    {
      "id": 0,
      "org_id": 0,
      "description": "string",
      "start_date": "2024-07-29T15:51:28.071Z",
      "end_date": "2024-07-29T15:51:28.071Z",
      "expiration_policy": 0,
      "status": "string",
      "discounts": [
        {
          "id": 0,
          "resource_id": 0,
          "resource_name": "string",
          "resource_count": 0,
          "discount_type": "string",
          "discount_code": "string",
          "discount_percent": 0,
          "discount_amount": 0,
          "discount_status": "string",
          "remaining_count": 0
        }
      ],
      "created_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "count": 0
}