Skip to main content
PUT
/
organizations
/
{orgId}
/
contracts
/
{id}
/
enddatebillingentities
End-date Contract Account billing entities
curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/contracts/{id}/enddatebillingentities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endDate": "2023-11-07T05:31:56Z",
  "billingEntities": [],
  "applyToChildren": true
}
'
{
  "statusMessage": "<string>",
  "updatedEntities": {
    "CONTRACT": {
      "empty": true
    },
    "ACCOUNTPLAN": {
      "empty": true
    },
    "PREPAYMENT": {
      "empty": true
    },
    "PRICINGS": {
      "empty": true
    },
    "COUNTER_PRICINGS": {
      "empty": true
    }
  },
  "failedEntities": {
    "CONTRACT": {
      "empty": true
    },
    "ACCOUNTPLAN": {
      "empty": true
    },
    "PREPAYMENT": {
      "empty": true
    },
    "PRICINGS": {
      "empty": true
    },
    "COUNTER_PRICINGS": {
      "empty": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

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

​
id
string
required

Unique identifier (UUID) of the Contract - the specified billing entities associated with the Account the Contract has been added to will be end-dated.

Body

application/json
​
endDate
string<date-time>
required

The end date and time applied to the specified billing entities (in ISO 8601 format).

​
billingEntities
enum<string>[]
required

Defines which billing entities associated with the Account will have the specified end-date applied. For example, if you want the specified end-date to be applied to all Prepayments/Commitments created for the Account use "PREPAYMENT".

Minimum array length: 1
Available options:
CONTRACT,
ACCOUNTPLAN,
PREPAYMENT,
PRICINGS,
COUNTER_PRICINGS
​
applyToChildren
boolean

A Boolean TRUE/FALSE flag. For Parent Accounts, set to TRUE if you want the specified end-date to be applied to any billing entities associated with Child Accounts. (Optional)

Response

Return the status and details of the updated active billing entities

​
statusMessage
string

A message indicating the status of the operation.

​
updatedEntities
object

A dictionary with keys as identifiers of billing entities and values as lists containing details of the updated entities.

​
failedEntities
object

A dictionary with keys as identifiers of billing entities and values as lists containing details of the entities for which the update failed.