Update End Date

API Reference

V1

Contracts

Update the contract end date

client.v1.contracts.updateEndDate(ContractUpdateEndDateParamsbody, RequestOptionsoptions?): dataIDContractUpdateEndDateResponse

post/v1/contracts/updateEndDate

Update the end date of a contract

Parameters

bodycontract_idstringcustomer_idstringallow_ending_before_finalized_invoicebooleanending_beforestringContractUpdateEndDateParams

Hide ParametersShow Parameters

contract_idstring

ID of the contract to update

formatuuid

customer_idstring

ID of the customer whose contract is to be updated

formatuuid

allow_ending_before_finalized_invoiceboolean

optional

If true, allows setting the contract end date earlier than the end_timestamp of existing finalized invoices. Finalized invoices will be unchanged; if you want to incorporate the new end date, you can void and regenerate finalized usage invoices. Defaults to true.

ending_beforestring

optional

RFC 3339 timestamp indicating when the contract will end (exclusive). If not provided, the contract will be updated to be open-ended.

formatdate-time

Returns

ContractUpdateEndDateResponse

Hide ParametersShow Parameters

dataidstringID

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

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

const response = await client.v1.contracts.updateEndDate({
  contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
  customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
  ending_before: '2020-01-01T00:00:00.000Z',
});

console.log(response.data);

200 Example

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