Contract
Contract Object¶
| KEY | VALUE TYPE | VALUE DESCRIPTION |
|---|---|---|
| _id | String | A unique resource ID for the contract. |
| created | String | The timestamp that indicates when the contract was created. |
| createdBy | String | The consumer who created the contract. |
| lastModified | String | The timestamp that indicates when the contract was last modified. |
| lastModifiedBy | String | The consumer who last modified the contract. |
| active | Boolean | Specifies if the contract is active. |
| name | String | Identifies the contract in a human readable way and is unique inside a contract. |
| slug | String | A unique human readable slugified identifier for the contract. This is an auto generated field upon creation, which can't be modified. |
| customerId | String | A resource ID that specifies to which customer the contract belongs. |
| productId | String | A resource ID that specifies to which product the contract belongs. |
| consumers | Array | A list of consumers that have access to the contract. This property is not given out for the /contracts/me endpoint. |
| filterId | String | Optional. A resource ID that specifies a filter for the contract. |
| label | String | Optional. A custom contract name (different from the name property) that can be modified. |