Archive a credit

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

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

Credits and commits

Archive a credit

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

Example workflow: The customer was granted a free credit erroneously. It was applied to their most recent finalized invoice.

First, void the finalized invoice that the credit was applied to.
Then, use the archiveCredit endpoint to deactivate the credit.
Finally, regenerate the voided invoice. The invoice will be regenerated without the application of the credit, which has now been archived.

Usage guidelines:

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

POST

contracts

credits

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 Credit ID to archive

customer_id

string<uuid>

required

ID of the customer whose credit is being archived

credit_id

string<uuid>

required

ID of the credit to archive

Response

Success

data

object

required

Show child attributes

Archive a commit

Create a customer

⌘I