Skip to main content
PUT
/
admin
/
contracts
/
{company_id}
Update Contract
curl --request PUT \
  --url https://api-dev.narrative.io/admin/contracts/{company_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "rates": [
    {
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sku": "<string>",
      "end": "2023-11-07T05:31:56Z"
    }
  ],
  "internal_notes": "<string>",
  "revision_notes": "<string>"
}
'
{
  "createdContract": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payable_company_id": 123,
    "payment_method": {},
    "revision": 123,
    "revision_start": "2023-11-07T05:31:56Z",
    "updated_by": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "internal_notes": "<string>",
    "revision_notes": "<string>",
    "revision_end": "2023-11-07T05:31:56Z"
  },
  "createdRates": [
    {
      "contract_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contract_revision": 123,
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rate": {
        "unit_price": {
          "value": 123,
          "expressed_in": "cents",
          "currency": "USD"
        }
      },
      "start_at": "2023-11-07T05:31:56Z",
      "end_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
company_id
number
required

Unique identifier for a company.

Body

application/json
​
start
string<date-time>

Start date of a contract. If not specified it will be set to now

​
end
string<date-time>

Optional end date of a contract

​
payment_method
object

Payment Method

​
rates
object[]

Optional rates associated to a contract

​
internal_notes
string
​
revision_notes
string

Response

Return created contract with rates

​
createdContract
object
required
​
createdRates
object[]