Archive

API Reference

V1

Contracts

Archive a contract

post/v1/contracts/archive

Archive a contract

Body Parameters

contract_idstring

ID of the contract to archive

formatuuid

customer_idstring

ID of the customer whose contract is to be archived

formatuuid

void_invoicesboolean

If false, the existing finalized invoices will remain after the contract is archived.

Returns

dataidstringID

HTTPTypeScriptPythonGoRubyTerraform

curl https://api.metronome.com/v1/contracts/archive \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "contract_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
          "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
          "void_invoices": true
        }'

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}