Edit Credit

API Reference

V2

Contracts

Edit a credit

client.v2.contracts.editCredit(ContractEditCreditParamsbody, RequestOptionsoptions?): dataIDContractEditCreditResponse

post/v2/contracts/credits/edit

Edit a customer or contract credit. Contract credits can only be edited using this endpoint if contract editing is enabled.

Parameters

bodycredit_idstringcustomer_idstringaccess_scheduleAccessScheduleapplicable_product_idsunionapplicable_product_tagsunionpriorityunionproduct_idstringspecifiersunionContractEditCreditParams

Hide ParametersShow Parameters

credit_idstring

ID of the credit to edit

formatuuid

customer_idstring

ID of the customer whose credit is being edited

formatuuid

access_scheduleAccessSchedule

optional

Hide ParametersShow Parameters

add_schedule_itemsarray

optional

Array<AddScheduleItem>

Hide ParametersShow Parameters

amountnumber

ending_beforestring

formatdate-time

starting_atstring

formatdate-time

remove_schedule_itemsarray

optional

Array<RemoveScheduleItem>

Hide ParametersShow Parameters

idstring

formatuuid

update_schedule_itemsarray

optional

Array<UpdateScheduleItem>

Hide ParametersShow Parameters

idstring

formatuuid

amountnumber

optional

ending_beforestring

optional

formatdate-time

starting_atstring

optional

formatdate-time

applicable_product_idsunion

optional

Array<string> | null

Which products the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.

applicable_product_tagsunion

optional

Array<string> | null

Which tags the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.

priorityunion

optional

number | null

If multiple commits are applicable, the one with the lower priority will apply first.

product_idstring

optional

formatuuid

specifiersunion

optional

Array<Specifier> | null

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

Hide ParametersShow Parameters

presentation_group_valuesRecord<string, string>

optional

pricing_group_valuesRecord<string, string>

optional

product_idstring

optional

If provided, the specifier will only apply to the product with the specified ID.

formatuuid

product_tagsarray

optional

Array<string>

If provided, the specifier will only apply to products with all the specified tags.

Returns

ContractEditCreditResponse

Hide ParametersShow Parameters

dataidstringID

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v2.contracts.editCredit({
  credit_id: '5e7e82cf-ccb7-428c-a96f-a8e4f67af822',
  customer_id: '4c91c473-fc12-445a-9c38-40421d47023f',
  access_schedule: {
    update_schedule_items: [
      { id: 'd5edbd32-c744-48cb-9475-a9bca0e6fa39', ending_before: '2025-03-12T00:00:00Z' },
    ],
  },
});

console.log(response.data);

200 Example

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