Account8

AccountPlan6

Aggregation5

Auth1

BalanceChargeSchedule6

Balances8

BalanceTransactionSchedule6

Bill20

BillConfig2

BillGroupingKey5

BillJob5

Charge5

Commitments6

CompoundAggregation5

Contract6

Counter5

CounterAdjustments5

CounterPricing5

CreditReason5

Credits5

Currency5

CustomField2

DataExplorer20

DataExplorerV26

DebitReason5

Debits5

Events4

ExportAdHoc1

ExportDestination6

ExportJob2

ExportSchedule5

External Mapping8

ExternalMappings2

IntegrationConfigs12

IntegrationCredentials5

IntegrationDestinations22

IntegrationRuns7

IntegrationTransformations7

Invitations3

Line Item1

LookupTable5

LookupTableRevision6

LookupTableRevisionData13

Marketplace Integrations1

Measurements6

Meter5

MeterGroup5

Notifications6

OrganizationConfig2

OrgUsers6

PermissionPolicy13

Plan5

PlanGroup5

PlanGroupLink5

PlanTemplate5

Pricing5

Product5

ResourceGroup9

ScheduledEventConfigurations5

ServiceUser6

ServiceUserCredentials6

StatementDefinition5

StatementJob5

Support3

TransactionType5

User1

Contract

Update Contract

Changed on Oct 16, 2026

Update the Contract with the given UUID.

This endpoint updates the details of the Contract with the specified ID. Used to modify details of an existing Contract such as the start or end dates.

Note: If you have created Custom Fields for a Contract, when you use this endpoint to update the Contract use the customFields parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.

put/organizations/{orgId}/contracts/{id}

Request

Base URL
https://api.m3ter.com
Auth
OAuth 2
Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
Client credentialsToken URL /oauth/token
TypeScript
https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/contracts/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

idstring required

The unique identifier (UUID) of the Contract to update.

Request body

versioninteger

The version number of the entity:

Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.

customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level, customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

accountIdstring required

The unique identifier (UUID) of the Account associated with this Contract.

namestring required

The name of the Contract.

codestring

The short code of the Contract.

descriptionstring

The description of the Contract, which provides context and information.

purchaseOrderNumberstring

The Purchase Order Number associated with the Contract.

applyContractPeriodLimitsboolean

For Contract billing, a boolean setting for restricting the charges billed to the period defined for the Contract:

TRUE - Contract billing for the Account will be restricted to charge amounts that fall within the defined Contract period.
FALSE - The period for amounts billed under the Contract will be determined by the Account Plan attached to the Account and linked to the Contract.(Default)

billGroupingKeyIdstring

The ID of the Bill Grouping Key assigned to the Contract.

If you are implementing Contract Billing for an Account, use billGroupingKey to control how charges linked to Contracts on the Account will be billed:

Independent Contract billing. Assign an exclusive Bill Grouping Key to the Contract - only charges due against the Account and linked to the single Contract will appear on a separate Bill.
Collective Contract billing. Assign the same non-exclusive Bill Grouping Key to multiple Contracts - all charges due against the Account and linked to the multiple Contracts will appear together on a single Bill.

startDatestring date required

The start date for the Contract (in ISO-8601 format). This date is inclusive, meaning the Contract is active from this date onward.

endDatestring date required

The exclusive end date of the Contract (in ISO-8601 format). This means the Contract is active until midnight on the day before this date.

Response

Returns the updated Contract

idstring required

The UUID of the entity.

versioninteger

The version number:

Create: On initial Create to insert a new entity, the version is set at 1 in the response.
Update: On successful Update, the version is incremented by 1 in the response.

customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

accountIdstring

The unique identifier (UUID) of the Account associated with this Contract.

namestring

The name of the Contract.

codestring

The short code of the Contract.

descriptionstring

The description of the Contract, which provides context and information.

purchaseOrderNumberstring

The Purchase Order Number associated with the Contract.

applyContractPeriodLimitsboolean

For Contract billing, a boolean setting for restricting the charges billed to the period defined for the Contract:

TRUE - Contract billing for the Account will be restricted to charge amounts that fall within the defined Contract period.
FALSE - The period for amounts billed under the Contract will be determined by the Account Plan attached to the Account and linked to the Contract.(Default)

billGroupingKeyIdstring

The ID of the Bill Grouping Key assigned to the Contract.

startDatestring date

The start date for the Contract (in ISO-8601 format). This date is inclusive, meaning the Contract is active from this date onward.

endDatestring date

The exclusive end date of the Contract (in ISO-8601 format). This means the Contract is active until midnight on the day before this date.

dtCreatedstring date-time

The date and time (in ISO-8601 format) when the Contract was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the Contract was last modified.

createdBystring

The unique identifier (UUID) of the user who created this Contract.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this Contract.

Changes

Oct 16, 202685c514abc692 Revision changes
- breaking
  added subschema #1 subschema #2 to the ///// request property allOf list
- breaking
  the //// request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  the //// response's property type changed from no type to object for status
- breaking
  the response's property type changed from no type to object for status
Dec 3, 2025ac93d1a9e6d9 Revision changes
- warning
  removed the optional property / from the response with the status
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status

Operation history (5 revisions)