Jump to

• Request
• Response
• Examples

View Subscription Details of an Account

get

/metering/api/v1/cloudbucks/{accountId}

Retrieve subscription details of services and entitlements belonging to an account or identity domain.

Request

Path Parameters

• accountId: string
  Account name, starts with cacct.

Query Parameters

• entitlementIds: string
  Comma separated list of Service Entitlement Ids.

Back to Top

Response

Supported Media Types

• application/vnd.com.oracle.oraclecloud.metering.cloudbucks+json

200 Response

Success

Body ()

Root Schema : CloudBucks

Type: object

Title: CloudBucks

Show Source

• canonicalLink(optional): string
• items(optional): array items

{
    "type":"object",
    "title":"CloudBucks",
    "properties":{
        "items":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_CloudBuck"
                }
            }
        },
        "canonicalLink":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_CloudBuck"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object CloudBuck
  Title: CloudBuck

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_CloudBuck"
    }
}

Nested Schema : CloudBuck

Type: object

Title: CloudBuck

Show Source

• balance(optional): array balance
• billingType(optional): string
• canonicalLink(optional): string
• cbProperties(optional): array cbProperties
• cloudBucksType(optional): string
• consumed(optional): number
• entitlementId(optional): string
• hardLimitAll(optional): number
• hardLimitNew(optional): number
• id(optional): string
• overagesAllowed(optional): boolean
• purchase(optional): array purchase
• runningBalance(optional): array runningBalance
• serviceEntitlements(optional): array serviceEntitlements
• serviceType(optional): string
• softLimit(optional): number
• status(optional): string
• subscriptionCategory(optional): string
• subscriptionType(optional): string
  Title: SubscriptionType

  Allowed Values: [ "TRIAL", "PRODUCTION", "ORACLE_ASSIGNED_ENVIRONMENT" ]

{
    "type":"object",
    "title":"CloudBuck",
    "properties":{
        "subscriptionType":{
            "description":"",
            "$ref":"#/definitions/json_SubscriptionType"
        },
        "status":{
            "description":"",
            "type":"string"
        },
        "entitlementId":{
            "description":"",
            "type":"string"
        },
        "consumed":{
            "description":"",
            "type":"number"
        },
        "id":{
            "description":"",
            "type":"string"
        },
        "canonicalLink":{
            "description":"",
            "type":"string"
        },
        "hardLimitAll":{
            "description":"",
            "type":"number"
        },
        "hardLimitNew":{
            "description":"",
            "type":"number"
        },
        "overagesAllowed":{
            "description":"",
            "type":"boolean"
        },
        "softLimit":{
            "description":"",
            "type":"number"
        },
        "cloudBucksType":{
            "description":"",
            "type":"string"
        },
        "balance":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_Balance"
                }
            }
        },
        "purchase":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_Purchase"
                }
            }
        },
        "runningBalance":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_Balance"
                }
            }
        },
        "serviceEntitlements":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_ServiceEntitlement"
                }
            }
        },
        "serviceType":{
            "description":"",
            "type":"string"
        },
        "subscriptionCategory":{
            "description":"",
            "type":"string"
        },
        "cbProperties":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_CbProperties"
                }
            }
        },
        "billingType":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : balance

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_Balance"
        }
    }
}

Nested Schema : cbProperties

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_CbProperties"
        }
    }
}

Nested Schema : purchase

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_Purchase"
        }
    }
}

Nested Schema : runningBalance

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_Balance"
        }
    }
}

Nested Schema : serviceEntitlements

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_ServiceEntitlement"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Balance
  Title: Balance

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_Balance"
    }
}

Nested Schema : Balance

Type: object

Title: Balance

Show Source

• createdOn(optional): object createdOn
• id(optional): string
• purchasedResources(optional): array purchasedResources

{
    "type":"object",
    "title":"Balance",
    "properties":{
        "createdOn":{
            "description":"",
            "type":"object"
        },
        "id":{
            "description":"",
            "type":"string"
        },
        "purchasedResources":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_PurchasedResource"
                }
            }
        }
    },
    "description":""
}

Nested Schema : createdOn

Type: object

Nested Schema : purchasedResources

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_PurchasedResource"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object PurchasedResource
  Title: PurchasedResource

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_PurchasedResource"
    }
}

Nested Schema : PurchasedResource

Type: object

Title: PurchasedResource

Show Source

• createdOn(optional): object createdOn
• derived(optional): string
• displayName(optional): string
• endDate(optional): object endDate
• modifiedOn(optional): object modifiedOn
• name(optional): string
• orderLineId(optional): string
• quotaBalance(optional): number
• rateCardId(optional): string
• serviceName(optional): string
• startDate(optional): object startDate
• unit(optional): string
• value(optional): number

{
    "type":"object",
    "title":"PurchasedResource",
    "properties":{
        "name":{
            "description":"",
            "type":"string"
        },
        "value":{
            "description":"",
            "type":"number"
        },
        "unit":{
            "description":"",
            "type":"string"
        },
        "startDate":{
            "description":"",
            "type":"object"
        },
        "endDate":{
            "description":"",
            "type":"object"
        },
        "createdOn":{
            "description":"",
            "type":"object"
        },
        "modifiedOn":{
            "description":"",
            "type":"object"
        },
        "serviceName":{
            "description":"",
            "type":"string"
        },
        "derived":{
            "description":"",
            "type":"string"
        },
        "quotaBalance":{
            "description":"",
            "type":"number"
        },
        "displayName":{
            "description":"",
            "type":"string"
        },
        "rateCardId":{
            "description":"",
            "type":"string"
        },
        "orderLineId":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : createdOn

Type: object

Nested Schema : endDate

Type: object

Nested Schema : modifiedOn

Type: object

Nested Schema : startDate

Type: object

Nested Schema : items

Type: array

Show Source

• Array of: object CbProperties
  Title: CbProperties

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_CbProperties"
    }
}

Nested Schema : CbProperties

Type: object

Title: CbProperties

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "title":"CbProperties",
    "properties":{
        "key":{
            "description":"",
            "type":"string"
        },
        "value":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: object Purchase
  Title: Purchase

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_Purchase"
    }
}

Nested Schema : Purchase

Type: object

Title: Purchase

Show Source

• createdOn(optional): object createdOn
• hardLimitAll(optional): number
• hardLimitNew(optional): number
• id(optional): string
• overagesAllowed(optional): boolean
• purchasedResources(optional): array purchasedResources
• softLimit(optional): number

{
    "type":"object",
    "title":"Purchase",
    "properties":{
        "hardLimitAll":{
            "description":"",
            "type":"number"
        },
        "hardLimitNew":{
            "description":"",
            "type":"number"
        },
        "overagesAllowed":{
            "description":"",
            "type":"boolean"
        },
        "softLimit":{
            "description":"",
            "type":"number"
        },
        "id":{
            "description":"",
            "type":"string"
        },
        "createdOn":{
            "description":"",
            "type":"object"
        },
        "purchasedResources":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_PurchasedResource"
                }
            }
        }
    },
    "description":""
}

Nested Schema : createdOn

Type: object

Nested Schema : purchasedResources

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_PurchasedResource"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object PurchasedResource
  Title: PurchasedResource

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_PurchasedResource"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Balance
  Title: Balance

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_Balance"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ServiceEntitlement
  Title: ServiceEntitlement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_ServiceEntitlement"
    }
}

Nested Schema : ServiceEntitlement

Type: object

Title: ServiceEntitlement

Show Source

• dataJurisdictionName(optional): string
• id(optional): string
• serviceInstances(optional): array serviceInstances
• svcEntitlementSetId(optional): number
• svcEntProperties(optional): array svcEntProperties
• systemName(optional): string
• type(optional): string

{
    "type":"object",
    "title":"ServiceEntitlement",
    "properties":{
        "id":{
            "description":"",
            "type":"string"
        },
        "type":{
            "description":"",
            "type":"string"
        },
        "serviceInstances":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_ServiceInstance"
                }
            }
        },
        "systemName":{
            "description":"",
            "type":"string"
        },
        "dataJurisdictionName":{
            "description":"",
            "type":"string"
        },
        "svcEntProperties":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_Property"
                }
            }
        },
        "svcEntitlementSetId":{
            "description":"",
            "type":"number"
        }
    },
    "description":""
}

Nested Schema : serviceInstances

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_ServiceInstance"
        }
    }
}

Nested Schema : svcEntProperties

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_Property"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ServiceInstance
  Title: ServiceInstance

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_ServiceInstance"
    }
}

Nested Schema : ServiceInstance

Type: object

Title: ServiceInstance

Show Source

• dataJurisdictionName(optional): string
• id(optional): string
• status(optional): string
• systemName(optional): string

{
    "type":"object",
    "title":"ServiceInstance",
    "properties":{
        "id":{
            "description":"",
            "type":"string"
        },
        "status":{
            "description":"",
            "type":"string"
        },
        "systemName":{
            "description":"",
            "type":"string"
        },
        "dataJurisdictionName":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: object Property
  Title: Property

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_Property"
    }
}

Nested Schema : Property

Type: object

Title: Property

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "title":"Property",
    "properties":{
        "key":{
            "description":"",
            "type":"string"
        },
        "value":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Default Response

Unexpected error.

Back to Top

Examples

cURL Command

The following example shows how to retrieve Cloudbucks data by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -u [e-mail]
     -H "X-ID-TENANT-NAME:myDomain" 
     "https://itra.oraclecloud.com/metering/api/v1/cloudbucks/sseyz05242hng?entitlementIds=504299056,504299054"

Example of Request Body

There is no request body to submit with the HTTP request.

Example of Response Body

The following example shows the response body in JSON format.

{
    "items": [
        {
            "status": "ACTIVE",
            "entitlementId": "504299056",
            "id": "844327750",
            "canonicalLink": "/metering/api/v1/cloudbucks/sseyz05242hng/504299056",
            "hardLimitAll": 0,
            "hardLimitNew": 0,
            "overagesAllowed": false,
            "softLimit": 0,
            "balance": [
                {
                    "createdOn": "2017-05-24T15:54:11.249Z",
                    "id": "PZ844327759",
                    "purchasedResources": [
                        {
                            "name": "CLOUD_CREDIT_AMOUNT",
                            "value": 0,
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "modifiedOn": "2017-05-24T15:54:11.249Z",
                            "derived": "N"
                        }
                    ]
                },
                {
                    "createdOn": "2017-05-24T15:54:11.249Z",
                    "id": "504295272",
                    "purchasedResources": [
                        {
                            "name": "BYTES_USED",
                            "value": 2048,
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "modifiedOn": "2017-05-24T15:54:11.249Z",
                            "serviceName": "Storage",
                            "derived": "N",
                            "quotaBalance": 2048,
                            "displayName": "Standard Gigabytes Used"
                        },
                        {
                            "name": "BYTES_EGRESS",
                            "value": 20,
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "modifiedOn": "2017-05-24T15:54:11.249Z",
                            "serviceName": "Storage",
                            "derived": "Y",
                            "quotaBalance": 20,
                            "displayName": "Gigabytes Egressed"
                        },
                        {
                            "name": "WRITE_REQUESTS",
                            "value": 2000000,
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "modifiedOn": "2017-05-24T15:54:11.249Z",
                            "serviceName": "Storage",
                            "derived": "Y",
                            "quotaBalance": 2000000,
                            "displayName": "Write Requests"
                        },
                        {
                            "name": "READ_REQUESTS",
                            "value": 2000000,
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "modifiedOn": "2017-05-24T15:54:11.249Z",
                            "serviceName": "Storage",
                            "derived": "Y",
                            "quotaBalance": 2000000,
                            "displayName": "Read Requests"
                        }
                    ]
                }
            ],
            "purchase": [
                {
                    "hardLimitAll": 0,
                    "hardLimitNew": 0,
                    "overagesAllowed": false,
                    "softLimit": 0,
                    "id": "504295272",
                    "createdOn": "2017-05-24T15:54:11.249Z",
                    "purchasedResources": [
                        {
                            "name": "BYTES_USED",
                            "value": 2048,
                            "startDate": "2017-05-24T16:18:27.000Z",
                            "endDate": "2020-05-23T16:18:27.000Z",
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "serviceName": "Storage",
                            "derived": "N",
                            "displayName": "Standard Gigabytes Used"
                        },
                        {
                            "name": "BYTES_EGRESS",
                            "value": 20,
                            "startDate": "2017-05-24T16:18:27.000Z",
                            "endDate": "2020-05-23T16:18:27.000Z",
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "serviceName": "Storage",
                            "derived": "Y",
                            "displayName": "Gigabytes Egressed"
                        },
                        {
                            "name": "WRITE_REQUESTS",
                            "value": 2000000,
                            "startDate": "2017-05-24T16:18:27.000Z",
                            "endDate": "2020-05-23T16:18:27.000Z",
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "serviceName": "Storage",
                            "derived": "Y",
                            "displayName": "Write Requests"
                        },
                        {
                            "name": "READ_REQUESTS",
                            "value": 2000000,
                            "startDate": "2017-05-24T16:18:27.000Z",
                            "endDate": "2020-05-23T16:18:27.000Z",
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "serviceName": "Storage",
                            "derived": "Y",
                            "displayName": "Read Requests"
                        }
                    ]
                },
                {
                    "hardLimitAll": 0,
                    "hardLimitNew": 0,
                    "overagesAllowed": true,
                    "softLimit": 0,
                    "id": "PZ844327759",
                    "createdOn": "2017-05-24T15:54:11.249Z",
                    "purchasedResources": [
                        {
                            "name": "CLOUD_CREDIT_AMOUNT",
                            "value": 0,
                            "createdOn": "2017-05-24T15:54:11.249Z"
                        }
                    ]
                }
            ],
            "runningBalance": [
                {
                    "createdOn": "2017-05-24T15:54:11.249Z",
                    "id": "PZ844327759",
                    "purchasedResources": [
                        {
                            "name": "CLOUD_CREDIT_AMOUNT",
                            "value": 0,
                            "createdOn": "2017-05-24T15:54:11.249Z",
                            "modifiedOn": "2017-05-24T15:54:11.249Z",
                            "derived": "N"
                        }
                    ]
                }
            ],
            "subscriptionType": "PRODUCTION",
            "serviceType": "Storage",
            "subscriptionCategory": "SRVC_ENTITLEMENT"
        },
        {
            "status": "ACTIVE",
            "entitlementId": "504299054",
            "id": "844328639",
            "canonicalLink": "/metering/api/v1/cloudbucks/sseyz05242hng/504299054",
            "hardLimitAll": 0,
            "hardLimitNew": 0,
            "overagesAllowed": false,
            "softLimit": 0,
            "balance": [
                {
                    "createdOn": "2017-05-24T15:54:21.621Z",
                    "id": "PZ844328641",
                    "purchasedResources": [
                        {
                            "name": "CLOUD_CREDIT_AMOUNT",
                            "value": 0,
                            "createdOn": "2017-05-24T15:54:21.621Z",
                            "modifiedOn": "2017-05-24T15:54:21.621Z",
                            "derived": "N"
                        }
                    ]
                },
                {
                    "createdOn": "2017-05-24T15:54:21.621Z",
                    "id": "504295270",
                    "purchasedResources": [
                        {
                            "name": "DCS_EE_PAAS_GP_OCPU_HOUR",
                            "value": 2,
                            "createdOn": "2017-05-24T15:54:21.621Z",
                            "modifiedOn": "2017-07-04T11:51:58.365Z",
                            "serviceName": "DBAAS",
                            "derived": "N",
                            "quotaBalance": 2
                        }
                    ]
                }
            ],
            "purchase": [
                {
                    "hardLimitAll": 0,
                    "hardLimitNew": 0,
                    "overagesAllowed": false,
                    "softLimit": 0,
                    "id": "504295270",
                    "createdOn": "2017-05-24T15:54:21.621Z",
                    "purchasedResources": [
                        {
                            "name": "DCS_EE_PAAS_GP_OCPU_HOUR",
                            "value": 2,
                            "startDate": "2017-05-24T16:18:27.000Z",
                            "endDate": "2020-05-23T16:18:27.000Z",
                            "createdOn": "2017-05-24T15:54:21.621Z",
                            "serviceName": "DBAAS",
                            "derived": "N"
                        }
                    ]
                },
                {
                    "hardLimitAll": 0,
                    "hardLimitNew": 0,
                    "overagesAllowed": true,
                    "softLimit": 0,
                    "id": "PZ844328641",
                    "createdOn": "2017-05-24T15:54:21.621Z",
                    "purchasedResources": [
                        {
                            "name": "CLOUD_CREDIT_AMOUNT",
                            "value": 0,
                            "createdOn": "2017-05-24T15:54:21.621Z"
                        }
                    ]
                }
            ],
            "runningBalance": [
                {
                    "createdOn": "2017-05-24T15:54:21.621Z",
                    "id": "PZ844328641",
                    "purchasedResources": [
                        {
                            "name": "CLOUD_CREDIT_AMOUNT",
                            "value": 0,
                            "createdOn": "2017-05-24T15:54:21.621Z",
                            "modifiedOn": "2017-05-24T15:54:21.621Z",
                            "derived": "N"
                        }
                    ]
                }
            ],
            "subscriptionType": "PRODUCTION",
            "serviceType": "DBAAS",
            "subscriptionCategory": "SRVC_ENTITLEMENT"
        }
    ],
    "canonicalLink": "/metering/api/v1/cloudbucks/sseyz05242hng"
}

Back to Top