Contract

Profile

A Contract represents information about a merchant agreement. Full details are available via Content Negotiation.

Properties

name type
id string
signer.name1 string
signer.email1 email
metadata.state string
metadata.signed_at1 ISO 8601
metadata.declined_at1 ISO 8601
metadata.declined_reason1 string
1
Presence depends on metadata.state.
rel conditional
self false
ch:application false
ch:record false
ch:stamps1 true
1
Presence depends on metadata.state.

Additional semantics

This resource supports Stamps. See Stamps for more information.

name meaning removable
signed Mark the contract as signed false
declined1 Mark the contract as declined false
1
Supports an optional note request parameter that will be available as metadata.declined_reason.

Content negotiation

This resource supports media type application/pdf.

Example representation

{
  "id": "eb33d586-2968-4a94-843b-bf1e8479416f",
  "metadata": {
    "state": "signed",
    "signed_at": "2016-07-26T13:39:29.461Z",
  },
  "signer": {
    "name": "Mia M. Lassen",
    "email": "MiaMLassen@example.com"
  },
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f",
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:record": {
      "href": "https://merchant.test.clearhaus.com/records/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:stamps": [
      {
        "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f/stamps/signed",
        "name": "signed"
      },
      {
        "href": "https://merchant.test.clearhaus.com/contracts/eb33d586-2968-4a94-843b-bf1e8479416f/stamps/declined",
        "name": "declined"
      }
    ],
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}

This browser does not support PDFs. Please download the PDF to view it: Download.

Open Navigation Close Navigation