BillingUsage-BAN-get

Set Admin Credentials...
BillingUsage-BAN-get

get

BillingUsage-BAN-get

The Billing Usage API enables you to view the traffic upon which your invoice is based directly from your own portal without having to log into the Verizon Enterprise Center. With this API, you can see the total gigabytes of data which are passed over a Secure Cloud Interconnect connection for a specified date range. Both ingress and egress traffic can be viewed. You are able to specify the traffic which you would like to see by providing the Billing Account Number (BAN) ID, month, and year. You have the option to enter a start date and end date in the month. The start and end dates are restricted to the 30/31 days in the month selected. If a start and end date are not provided, the data will be automatically pulled for the entire month. You will see usage detail for each Service ID under that BAN.



Resource URL

 
Environment URL
Production

https://digitalconnectproxy.verizon.com:443/sci /BillingUsage/{BAN}

   
Test

https://https://digitalconnectproxy.verizon.com:443/sci /BillingUsage/{BAN}

   
Note :- You can replace {serviceId} with your sci service id or 176890840 to test the API. Note :- You can replace {BAN} with your BAN or KR00108392 to test the API.

Query Parameters

 
Name Values Description
startDay
(optional)

A number between 1 - 31.
Note :Cannot exceed current day of the month.
endDay
(optional)

A number between 1 - 31.
Note : endDay should be >= startDay and cannot exceed current day of the month.
month
(required)

year
(required)

Attribute NameType Description
usageData(Json Array)
customerNamestringName of the customer
cloudTypestringType of Cloud. Eg : VPC , Dedicated VPC,Public.
aggregationRegionstringAggregated region of the SCI connection
dataPlanNamestringSCI Connection plan name
asOfDatestringUsage comsumption date
locationNamestringLocation of Cloud Service Provider.
aggregationFlagstringAggregation plan indicator
overageConsumptionstringData consumed past the data plan in GB.
cumulativeUsagestringCumulative Usage of the month
serviceIdstringService Instance Id of the SCI Connection
billCycleEndDatestringBilling Cycle End Date
billCycleStartDatestringBilling Cycle Start Date
cloudProviderstringCloud Service Provider Name
dailyUsagestringUsage comsumption of particular date (asOfDate)
usageMeta(Json)
timestampstringThis is the current response time stamp of the usage data. It will be in " DD-MON-YY HH:MM:SS " format.
banstringBilling Account Number of the Customer
statusstringStatus of the request ( success of failure )
monthYearstringMonth and Year value from the request
Attribute NameType Description
usageData(Json Array)
customerNamestringName of the customer
cloudTypestringType of Cloud. Eg : VPC , Dedicated VPC,Public.
aggregationRegionstringAggregated region of the SCI connection
dataPlanNamestringSCI Connection plan name
asOfDatestringUsage comsumption date
locationNamestringLocation of Cloud Service Provider.
aggregationFlagstringAggregation plan indicator
overageConsumptionstringData consumed past the data plan in GB.
cumulativeUsagestringCumulative Usage of the month
serviceIdstringService Instance Id of the SCI Connection
billCycleEndDatestringBilling Cycle End Date
billCycleStartDatestringBilling Cycle Start Date
cloudProviderstringCloud Service Provider Name
dailyUsagestringUsage comsumption of particular date (asOfDate)
usageMeta(Json)
timestampstringThis is the current response time stamp of the usage data. It will be in " DD-MON-YY HH:MM:SS " format.
banstringBilling Account Number of the Customer
statusstringStatus of the request ( success of failure )
monthYearstringMonth and Year value from the request

Body Parameters

Name Values Description
body
(required)

Sample Request

 

BAN Billing account number true

Please login to send the sample request and get a reponse back.

Working...