Pay-per-use API

Overview

This API allows you to control the usage fee information for NTT Com Services.

Resource URL

Please use global common domain, or the individual region domain.

If you want to use the global common domain, depending on the circumstances of your available points, your request connect to the nearest API gateway.

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/business-process/pay-per-use

2.Base Path(Region)

https://{region}.api.ntt.com/v1/business-process/pay-per-use
  • region is jp|us|fr|sg
  • e.g. https://us.api.ntt.com/v1/business-process/pay-per-use

Resource Information

Key Value
Response Format JSON
Authentication (OAuth) Yes
Bandwidth control#1 Yes
  • #1 implement appropriate flow restriction in the customer connection unit

GET Usage fee Info

GET /v1/business-process/pay-per-use/{contractId}

Request Parameters

Name Description type mandatory
contractId Service Contract ID path Yes
serviceName Service Name#1 query argument Yes
chargeYearmonth Bill of Period #2,#3 query argument
  • #1 ell-flexible
  • #2 It is specifies in YYYYMM(6) format.
  • #3 If you don't set chargeYearmonth, API Gateway responses the usage fee of this and last month.

Example Request

 GET /v1/business-process/pay-per-use/Nxxxxxxxxxx?serviceName=ip-voice

Response Parameters

No Name Description Type String
1 result Result#1 String 6
2 chargeItemAmountInfo Usage Fee Informaion#2 Array -
2-1 row Data Row Object -
2-1-1 billContractId Number of Contract String 64
2-1-2 useYearmonth Use Year and Month#3 String 6
2-1-3 accessLineKind Access Line Kind(000160:NTTCom Hikari Access/000282:Housing) String 10
2-1-4 billItem Classification of the Price(0:Standard/1:Adding) String 1
2-1-5 useBandwidth Use Bandwidth#4 String 64
2-1-6 addBandwidth Bandwidth speed increase#5 String 64
2-1-7 effectiveDate Use Start Date#6 String 4
2-1-8 terminationDate Use End Date#6 String 4
2-1-9 chargeItemAmount Amount of Money String 64
3 chargeAmountInfo Usage Fee Total Informaion#2 Array -
3-1 row Data Row Object -
3-1-1 billContractId Number of Contract String 64
3-1-2 useYearmonth Use Year and Month#3 String 6
3-1-3 chargeAmount Total Fee String 64

  • #1 Error Code below.

    Code Name Description
    000000 Success Successful completion.
    100000 No Data No data found.
    111000 Regulation Service unavailable by regulation.
    910000 Parameter Error Bad request parameters.
    920000 Resource Error Cannot access local resources.
    930000 Internal Error API service internal error.
    990000 Internal Error Unexpected error

  • #2 This parameter is set when result is success.

  • #3 It is set in YYYYMM(6) format.
  • #4 It is set a value of Mbps.
  • #5 It is set a value of Mbps.
  • #6 It is set in MMDD(4) format.

Example Result

{
    "chargeAmountInfo": [
        {
            "row": {
                "billContractId": "N*********", 
                "chargeAmount": "19354", 
                "useYearmonth": "201603"
            }
        }
    ], 
    "chargeItemAmountInfo": [
        {
            "row": {
                "accessLineKind": "000160", 
                "addBandwidth": "0", 
                "billContractId": "N*********", 
                "billItem": "0", 
                "chargeItemAmount": "19354", 
                "effectiveDate": "0314", 
                "terminationDate": "0317", 
                "useBandwidth": "500", 
                "useYearmonth": "201603"
            }
        }
    ], 
    "result": "000000"
}