MEA price lists

MEA price lists contain standalone selling prices for items sold in multiple-element arrangements. A company that provides multiple products and/or services to customers as part of a single arrangement needs to create one or more MEA price lists. A contract that contains multiple-element arrangements can be linked to an MEA price list.

List MEA price lists

get/objects/contracts/mea-price-list

Returns up to 100 MEA price lists from the collection with a key, ID, and link for each list. This operation is mostly for use in testing; use the query service to find MEA price lists that meet specific criteria and to specify the properties that you want in the response.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "30",
      • "id": "CONMEA_FVPriceBand_Amount_USD",
      • "href": "/objects/contracts/mea-price-list/30"
      },
    • {
      • "key": "31",
      • "id": "CONMEA_FVPriceBand_Amount_EUR",
      • "href": "/objects/contracts/mea-price-list/31"
      },
    • {
      • "key": "32",
      • "id": "CONMEA_FVPriceBand_Amount_GBP",
      • "href": "/objects/contracts/mea-price-list/32"
      },
    • {
      • "key": "33",
      • "id": "CONMEA_FVPriceBand_Amount_INR",
      • "href": "/objects/contracts/mea-price-list/33"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Create an MEA price list

post/objects/contracts/mea-price-list

Creates a new MEA price list.

SecurityOAuth2
Request
Request Body schema: application/json
required

MEA price list to create

id
required
string

Unique name or ID for the MEA price list.

Example: "Subscription MEA price list"
description
string

Description of the MEA price list.

Example: "Fair value for high-volume customers"
isDefault
boolean

Set to true to make this the default price list.

Example: false
status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
Example: "active"
Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "status": "active",
  • "id": "CONMEA_FVPriceBand_Amount_USD_1",
  • "description": "MEA NearestBoundary PriceBand Amount"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "39",
    • "id": "CONMEA_FVPriceBand_Amount_USD_2",
    • "href": "/objects/contracts/mea-price-list/39"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get an MEA price list

get/objects/contracts/mea-price-list/{key}

Returns detailed information for a specified MEA price list.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the MEA price list.

Example: 61
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "37",
    • "audit": {
      • "createdDateTime": "2023-06-08T06:06:15Z",
      • "modifiedDateTime": "2023-06-08T06:06:15Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "status": "active",
    • "id": "CONMEA_FVPriceBand_Amount_USD_2",
    • "description": "MEA NearestBoundary PriceBand Amount",
    • "isDefault": false,
    • "href": "/objects/contracts/mea-price-list/37"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an MEA price list

patch/objects/contracts/mea-price-list/{key}

Update an existing MEA price list by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the MEA price list.

Example: 61
Request Body schema: application/json
description
string

Description of the MEA price list.

Example: "Fair value for high-volume customers"
isDefault
boolean

Set to true to make this the default price list.

Example: false
status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
Example: "active"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "status": "active"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "38",
    • "id": "CONMEA_FVPriceBand_Amount_USD",
    • "href": "/objects/contracts/mea-price-list/38"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}

Delete an MEA price list

delete/objects/contracts/mea-price-list/{key}

Deletes an MEA price list. You can delete an MEA price list if it has not been used by any contracts. Deleted price lists cannot be recovered. Alternatively, you can change the status to Inactive, which prevents it from being used but retains the price list for historical purposes.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the MEA price list.

Example: 61
Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}