## Archive

`v1.contracts.archive(**kwargs) -> ContractArchiveResponse`

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

Archive a contract

### Parameters

- **contract\_id:** `String`

  ID of the contract to archive

- **customer\_id:** `String`

  ID of the customer whose contract is to be archived

- **void\_invoices:** `bool`

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

### Returns

- `class ContractArchiveResponse`

  - **data:** `ID`

### Example

```ruby
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

response = metronome.v1.contracts.archive(
  contract_id: "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d",
  void_invoices: true
)

puts(response)
```