## Archive

`client.v1.contracts.archive(ContractArchiveParamsbody, RequestOptionsoptions?): ContractArchiveResponse`

**post** `/v1/contracts/archive`

Archive a contract

### Parameters

- **body:** `ContractArchiveParams`

  - **contract\_id:** `string`

    ID of the contract to archive

  - **customer\_id:** `string`

    ID of the customer whose contract is to be archived

  - **void\_invoices:** `boolean`

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

### Returns

- `ContractArchiveResponse`
  - **data:** `ID`

### Example

```node
import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.contracts.archive({
  contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
  customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
  void_invoices: true,
});

console.log(response.data);
```