POST
/
v1
/
contracts
/
archive
Archive a contract
curl --request POST \
  --url https://api.metronome.com/v1/contracts/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
  "contract_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  "void_invoices": true
}'
{
  "data": {
    "id": "8deed800-1b7a-495d-a207-6c52bac54dc9"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Permanently end and archive a contract along with all its terms. Any draft invoices will be canceled, and all upcoming scheduled invoices will be voided–also all finalized invoices can optionally be voided. Use this in the event a contract was incorrectly created and needed to be removed from a customer.

Impact on commits and credits: When archiving a contract, all associated commits and credits are also archived. For prepaid commits with active segments, Metronome automatically generates expiration ledger entries to close out any remaining balances, ensuring accurate accounting of unused prepaid amounts. These ledger entries will appear in the commit's transaction history with type PREPAID_COMMIT_EXPIRATION.

Archived contract visibility: Archived contracts remain accessible for historical reporting and audit purposes. They can be retrieved using the ListContracts endpoint by setting the include_archived parameter to true or in the Metronome UI when the "Show archived" option is enabled.

The body is of type object.

Response

Success

The response is of type object.