curl --request GET \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries', 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://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries",
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: Basic <encoded-value>"
],
]);
$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://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body"{ \"object\":\"List\", \"data\":[ { \"object\":\"EventSummary\", \"account\":{ \"object\":\"Account\", \"id\":\"ACC_5\", \"vid\":\"811e1592ea4a610d83c716f40f53885d4a277cab\" }, \"subscription\":{ \"object\":\"Subscription\", \"id\":\"ACC_5_Subs3\", \"vid\":\"426b2721704b0e9e96811fa8a91fc86105d9518f\" }, \"subscription_item\":{ \"object\":\"SubscriptionItem\", \"id\":\"sub_1234.2\", \"vid\":\"7fdd1be818e7e203a302ac12d24dc77ecbf46508\" }, \"product\":{ \"object\":\"Product\", \"id\":\"PRD_003\", \"vid\":\"9ef4aff403a1698ccd85e22328720a01abef4652\" }, \"rate_plan\":{ \"object\":\"RatePlan\", \"id\":\"Rate_Step_1\", \"vid\":\"d10c5e32ca8ba89c5be6789ab9b04d486924e334\" }, \"current_total_rated_units_bill\":2, \"rated_unit_total\":0, \"rated_unit\":{ \"_hint\":{ \"source\":\"db\", \"load_val\":{ \"fkey\":{ \"ratable_usage_metric.merchant_id\":\"101436034\" }, \"ratable_usage_metric\":\"2702:101436034:movies:movie\" } }, \"ratable_usage_metric.merchant_id\":\"101436034\", \"_id\":\"rest3-staging.int-staging.us-west.vindicia.com24822258803-MC\", \"_debug\":\"0\", \"_class\":\"RatableUsageMetric\", \"_user_at_load\":\"373246495\", \"ratable_usage_metric.name_singular\":\"movie\", \"_cacheok\":\"0\", \"ratable_usage_metric.id\":\"2702\", \"__class\":\"Vindicia::Obj::RatableUsageMetric\", \"_obj_storage_type\":\"db\", \"_saveable\":\"1\", \"_jit\":null, \"ratable_usage_metric.name_plural\":\"movies\", \"_dirty\":\"0\", \"_jitok\":\"1\" }, \"event_count\":2 } ], \"total_count\":1, \"url\":\"/event_summaries?billed=0\" }"{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"list event summary
The Event Summary object defines (temporary) charges for a single Subscription Item and related information about the Item to which these charges refer. It is used to get a list of unbilled Event Summaries according to a rate plan.
curl --request GET \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries', 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://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries",
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: Basic <encoded-value>"
],
]);
$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://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/event_summaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body"{ \"object\":\"List\", \"data\":[ { \"object\":\"EventSummary\", \"account\":{ \"object\":\"Account\", \"id\":\"ACC_5\", \"vid\":\"811e1592ea4a610d83c716f40f53885d4a277cab\" }, \"subscription\":{ \"object\":\"Subscription\", \"id\":\"ACC_5_Subs3\", \"vid\":\"426b2721704b0e9e96811fa8a91fc86105d9518f\" }, \"subscription_item\":{ \"object\":\"SubscriptionItem\", \"id\":\"sub_1234.2\", \"vid\":\"7fdd1be818e7e203a302ac12d24dc77ecbf46508\" }, \"product\":{ \"object\":\"Product\", \"id\":\"PRD_003\", \"vid\":\"9ef4aff403a1698ccd85e22328720a01abef4652\" }, \"rate_plan\":{ \"object\":\"RatePlan\", \"id\":\"Rate_Step_1\", \"vid\":\"d10c5e32ca8ba89c5be6789ab9b04d486924e334\" }, \"current_total_rated_units_bill\":2, \"rated_unit_total\":0, \"rated_unit\":{ \"_hint\":{ \"source\":\"db\", \"load_val\":{ \"fkey\":{ \"ratable_usage_metric.merchant_id\":\"101436034\" }, \"ratable_usage_metric\":\"2702:101436034:movies:movie\" } }, \"ratable_usage_metric.merchant_id\":\"101436034\", \"_id\":\"rest3-staging.int-staging.us-west.vindicia.com24822258803-MC\", \"_debug\":\"0\", \"_class\":\"RatableUsageMetric\", \"_user_at_load\":\"373246495\", \"ratable_usage_metric.name_singular\":\"movie\", \"_cacheok\":\"0\", \"ratable_usage_metric.id\":\"2702\", \"__class\":\"Vindicia::Obj::RatableUsageMetric\", \"_obj_storage_type\":\"db\", \"_saveable\":\"1\", \"_jit\":null, \"ratable_usage_metric.name_plural\":\"movies\", \"_dirty\":\"0\", \"_jitok\":\"1\" }, \"event_count\":2 } ], \"total_count\":1, \"url\":\"/event_summaries?billed=0\" }"{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
The Account id or vid by which to filter Event Summaries. A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
128The Subscription id or vid to by which to filter Event Summaries. A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
128The Product id or vid by which to filter Event Summaries. A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
128The Rate Plan id or vid by which to filter Event Summaries.
The starting datetime for the range of Event Summaries you wish to retrieve.
The end datetime for the range of Event Summaries you wish to retrieve.
Boolean that allows to filter list for unbilled events (0).
Response
JSON A list array with a data property that contains an array of up to limit EventSummary.
-
"total_count": Integer count of the number of EventSummary in the returned list.
-
"url": The query string provided in the request.
"{ \"object\":\"List\", \"data\":[ { \"object\":\"EventSummary\", \"account\":{ \"object\":\"Account\", \"id\":\"ACC_5\", \"vid\":\"811e1592ea4a610d83c716f40f53885d4a277cab\" }, \"subscription\":{ \"object\":\"Subscription\", \"id\":\"ACC_5_Subs3\", \"vid\":\"426b2721704b0e9e96811fa8a91fc86105d9518f\" }, \"subscription_item\":{ \"object\":\"SubscriptionItem\", \"id\":\"sub_1234.2\", \"vid\":\"7fdd1be818e7e203a302ac12d24dc77ecbf46508\" }, \"product\":{ \"object\":\"Product\", \"id\":\"PRD_003\", \"vid\":\"9ef4aff403a1698ccd85e22328720a01abef4652\" }, \"rate_plan\":{ \"object\":\"RatePlan\", \"id\":\"Rate_Step_1\", \"vid\":\"d10c5e32ca8ba89c5be6789ab9b04d486924e334\" }, \"current_total_rated_units_bill\":2, \"rated_unit_total\":0, \"rated_unit\":{ \"_hint\":{ \"source\":\"db\", \"load_val\":{ \"fkey\":{ \"ratable_usage_metric.merchant_id\":\"101436034\" }, \"ratable_usage_metric\":\"2702:101436034:movies:movie\" } }, \"ratable_usage_metric.merchant_id\":\"101436034\", \"_id\":\"rest3-staging.int-staging.us-west.vindicia.com24822258803-MC\", \"_debug\":\"0\", \"_class\":\"RatableUsageMetric\", \"_user_at_load\":\"373246495\", \"ratable_usage_metric.name_singular\":\"movie\", \"_cacheok\":\"0\", \"ratable_usage_metric.id\":\"2702\", \"__class\":\"Vindicia::Obj::RatableUsageMetric\", \"_obj_storage_type\":\"db\", \"_saveable\":\"1\", \"_jit\":null, \"ratable_usage_metric.name_plural\":\"movies\", \"_dirty\":\"0\", \"_jitok\":\"1\" }, \"event_count\":2 } ], \"total_count\":1, \"url\":\"/event_summaries?billed=0\" }"

