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

These APIs are deprecated. See Cost Analysis Overview, Using the API for more information on how to track and optimize your Oracle Cloud Infrastructure spending. See the Deprecated Notices (Endpoints) to see if there is a replacement endpoint.

Back to Top