Contracts

Contracts define the service, service options and prices available for a carrier. A contract might be available because it is shared with you or because you added your own contract (including API credentials for that carrier).

Attributes

API specification

Attribute Type Description Required
name string A name for users to recognize the contract by.
currency string enum:
EUR
GBP
Currency code in ISO 4217 format.
credentials See credentials_format for carriers resource The carriers resource has a credentials_format describing how the credentials for that specific carrier should be provided. Credentials will not be returned for a get request and are stored encrypted.
status string enum:
pending
active
inactive
invalid
Newly created contracts are pending until verified. The user can manually switch between active and inactive once verified. After updating credentials, the contract goes back to pending. If verification fails, the contract will become invalid. read-only
Relationship Type Description Required
carrier carriers The carrier the contract is used for.
owner brokers
OR
organizations
The owner of the contract.

Endpoints

GET /contracts

GET /contracts/{contract_id}

POST /contracts

PATCH /contracts/{contract_id}

18-12-2018