Search Commitments - m3ter Documentation

Search Commitments

cURL

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

Python

import requests

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

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

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

print(response.text)

JavaScript (Fetch API)

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

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

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/commitments/search",
  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;
}
?>

Go

package main

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

func main() {

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

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))
}

Unirest (Java)

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

Ruby

require 'uri'
require 'net/http'

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

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

Response Codes

Example JSON Response

{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "accountId": "<string>",
      "billingPlanId": "<string>",
      "productIds": [
        "<string>"
      ],
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "currency": "<string>",
      "amount": 123,
      "amountPrePaid": 123,
      "amountFirstBill": 123,
      "amountSpent": 123,
      "overageSurchargePercent": 123,
      "separateOverageUsage": true,
      "billingInterval": 123,
      "billingOffset": 123,
      "commitmentFeeDescription": "<string>",
      "commitmentUsageDescription": "<string>",
      "overageDescription": "<string>",
      "commitmentFeeBillInAdvance": true,
      "billEpoch": "2023-12-25",
      "contractId": "<string>",
      "accountingProductId": "<string>",
      "feesAccountingProductId": "<string>",
      "drawdownsAccountingProductId": "<string>",
      "feeDates": [
        {
          "date": "2023-12-25",
          "amount": 1,
          "servicePeriodStartDate": "2023-11-07T05:31:56Z",
          "servicePeriodEndDate": "2023-11-07T05:31:56Z"
        }
      ],
      "lineItemTypes": [],
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Error Response

{
  "message": "<string>"
}

Authorization

Authorization

Path Parameters