Archive a commit

curl --request POST \
  --url https://api.metronome.com/v2/contracts/commits/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "4c91c473-fc12-445a-9c38-40421d47023f",
  "commit_id": "5e7e82cf-ccb7-428c-a96f-a8e4f67af822"
}
'

{
  "data": {
    "id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"
  }
}

Credits and commits

Archive a commit

Archive a contract-level or customer-level commit. Use this endpoint to deactivate a commit while preserving historical records. You will not be able to archive a commit until all of the finalized usage invoices the commit has been applied to are voided, and all of the finalized invoices for commit payment have been voided.

Example workflow: The customer was provisioned a prepaid commit erroneously. It was applied to their most recent finalized usage invoice.

First, void the finalized invoice that the commit was applied to. Also, void the finalized invoice associated with the commit payment.
Then, use the archiveCommit endpoint to deactivate the commit.
Finally, regenerate the voided invoice. The invoice will be regenerated without the application of the commit, which has now been archived.

Usage guidelines:

Once a commit has been archived, it will no longer appear by default on the endpoints listCustomerCommits or listCustomerBalances. Use the include_archived parameter to choose to fetch the details.
Once a commit has been archived, it has a null ledger and 0 remaining balance.
Archiving a commit fully deactivates the entire access schedule. If you want to reduce the amount granted in a commit, consider editing the access schedule using the editCommit endpoint, or adding a manual ledger entry using the addManualBalanceLedgerEntry endpoint.

POST

contracts

commits

Authorizations

Authorization

string

header

required

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

Body

application/json

Customer ID and Commit ID to archive

customer_id

string<uuid>

required

ID of the customer whose commit is being archived

commit_id

string<uuid>

required

ID of the commit to archive

Response

Success

data

object

required

Show child attributes

Disable trueup for commit

Archive a credit

⌘I