Contracts
ch:contracts
LINK RELATION
,
EMBEDDED RELATION
Actions
| method | description |
|---|---|
| GET | View contracts collection |
| OPTIONS | Retrieve supported HTTP methods |
Request parameters
| property | type | required | method |
|---|---|---|---|
| query1 | string | false | GET |
| page2 | integer | false | GET |
| per_page2 | integer | false | GET |
1
Supported modifiers:
state (one of: needs_signature, signed, declined, cancelled), merchant_id and effective_on (ISO 8601 date).
2
See Pagination for details.
Profile
The Contracts resource represents a collection of Contract resources.
Properties
| name | type | read-only |
|---|---|---|
| count | integer | true |
| page | integer | true |
| per_page | integer | true |
Link relations
| rel | conditional |
|---|---|
| self | false |
| first | true |
| prev | true |
| next | true |
Embedded
Additional semantics
This collection is paginated. See Pagination.
Example representation
{
"count": 1,
"page": 1,
"per_page": 20,
"_links": {
"self": {
"href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/contracts"
},
"curies": [
{
"href": "https://developer.clearhaus.com/rels/{rel}",
"templated": true,
"name": "ch"
}
]
},
"_embedded": {
"ch:contracts": [...]
}
}