Edit a credit

curl --request POST \
  --url https://api.metronome.com/v2/contracts/credits/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "4c91c473-fc12-445a-9c38-40421d47023f",
  "credit_id": "5e7e82cf-ccb7-428c-a96f-a8e4f67af822",
  "access_schedule": {
    "update_schedule_items": [
      {
        "id": "d5edbd32-c744-48cb-9475-a9bca0e6fa39",
        "ending_before": "2025-03-12T00:00:00Z"
      }
    ]
  }
}'

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

Credits and commits

Edit a credit

Edit details for a contract-level or customer-level credit.

Use this endpoint to:

Extend the duration or the amount of an existing free credit like a trial
Modify individual credit access schedules, applicable products, priority, or other fields.

Usage guidelines:

As with all edits in Metronome, draft invoices will reflect the edit immediately, while finalized invoices are untouched unless voided and regenerated.
You cannot remove an access schedule segment that was applied to a finalized invoice. You can void the invoice beforehand and then remove the access schedule segment.

POST

contracts

credits

edit

Edit a credit

curl --request POST \
  --url https://api.metronome.com/v2/contracts/credits/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "4c91c473-fc12-445a-9c38-40421d47023f",
  "credit_id": "5e7e82cf-ccb7-428c-a96f-a8e4f67af822",
  "access_schedule": {
    "update_schedule_items": [
      {
        "id": "d5edbd32-c744-48cb-9475-a9bca0e6fa39",
        "ending_before": "2025-03-12T00:00:00Z"
      }
    ]
  }
}'

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

Authorizations

Authorization

string

header

required

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

Body

application/json

Credit and customer IDs and fields to update

The body is of type object.

Response

Success

The response is of type object.

Edit a commit

Update the commit end date

GET STARTED

API REFERENCE

Edit a credit

Use this endpoint to:

Usage guidelines:

Authorizations

Body

Response