List CounterPricings - m3ter Documentation

List CounterPricings

cURL

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/counterpricings \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.m3ter.com/organizations/{orgId}/counterpricings"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.m3ter.com/organizations/{orgId}/counterpricings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/counterpricings",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "GET",\
  CURLOPT_HTTPHEADER => [\
    "Authorization: Bearer <token>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api.m3ter.com/organizations/{orgId}/counterpricings"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://api.m3ter.com/organizations/{orgId}/counterpricings")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/counterpricings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

HTTP Status Codes

• 200: Successful Response
• 4XX: Client Errors
• 5XX: Server Errors

Example Response

{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "planId": "<string>",
      "planTemplateId": "<string>",
      "cumulative": true,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "code": "<string>",
      "description": "<string>",
      "accountingProductId": "<string>",
      "pricingBands": [
        {
          "lowerLimit": 1,
          "fixedPrice": 123,
          "unitPrice": 123,
          "id": "<string>",
          "creditTypeId": "<string>"
        }
      ],
      "counterId": "<string>",
      "runningTotalBillInAdvance": true,
      "proRateRunningTotal": true,
      "proRateAdjustmentDebit": true,
      "proRateAdjustmentCredit": true
    }
  ],
  "nextToken": "<string>"
}

{
  "message": "<string>"
}

Authorization

Authorization
Type: string
Location: header
Required: Yes

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:
  Type: string
  Required: Yes
  Description: UUID of the Organization. Represents your company as a direct customer of m3ter.

Query Parameters

• pageSize:
  Type: integer<int32>
  Required: Yes
  Description: Number of CounterPricings to retrieve per page. Range: 1 <= x <= 200

• nextToken:
  Type: string
  Description: nextToken for multi-page retrievals.

• date:
  Type: string
  Description: Date on which to retrieve active CounterPricings.

• planId:
  Type: string
  Description: UUID of the Plan to retrieve CounterPricings for.

• planTemplateId:
  Type: string
  Description: UUID of the Plan Template to retrieve CounterPricings for.

• ids:
  Type: string[]
  Description: List of CounterPricing IDs to retrieve.

Response

Response Format: application/json
Returns the list of requested CounterPricings.

{
  "data": [<object[]>],
  "nextToken": "<string>"
}