## Edit Credit

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

**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

- **body:** `ContractEditCreditParams`

  - **credit\_id:** `string`

    ID of the credit to edit

  - **customer\_id:** `string`

    ID of the customer whose credit is being edited

  - **access\_schedule:** `AccessSchedule`

    - **add\_schedule\_items:** `Array<AddScheduleItem>`

      - **amount:** `number`

      - **ending\_before:** `string`

      - **starting\_at:** `string`

    - **remove\_schedule\_items:** `Array<RemoveScheduleItem>`

      - **id:** `string`

    - **update\_schedule\_items:** `Array<UpdateScheduleItem>`

      - **id:** `string`

      - **amount:** `number`

      - **ending\_before:** `string`

      - **starting\_at:** `string`

  - **applicable\_product\_ids:** `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\_tags:** `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.

  - **priority:** `number | null`

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

  - **product\_id:** `string`

  - **specifiers:** `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`.

    - **presentation\_group\_values:** `Record<string, string>`

    - **pricing\_group\_values:** `Record<string, string>`

    - **product\_id:** `string`

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

    - **product\_tags:** `Array<string>`

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

### Returns

- `ContractEditCreditResponse`
  - **data:** `ID`

### Example

```node
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);
```