Archive

API Reference

V1

Contracts

Archive a contract

v1.contracts.archive(ContractArchiveParams**kwargs) -> dataIDContractArchiveResponse

post/v1/contracts/archive

Archive a contract

Parameters

contract_idstr

ID of the contract to archive

formatuuid

customer_idstr

ID of the customer whose contract is to be archived

formatuuid

void_invoicesbool

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

Returns

ContractArchiveResponseclass

Hide ParametersShow Parameters

dataidstrID

HTTPTypeScriptPythonGoRubyTerraform

from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
response = client.v1.contracts.archive(
    contract_id="d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
    customer_id="13117714-3f05-48e5-a6e9-a66093f13b4d",
    void_invoices=True,
)
print(response.data)

200 Example

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