Oracle Cloud Infrastructure Documentation
Try Free Tier

OSub Usage Common Types

DBMS_CLOUD_OCI_OSUB_USAGE_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osub_usage_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OSUB_USAGE_PRODUCT_T Type

Product description

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osub_usage_product_t FORCE AUTHID CURRENT_USER IS OBJECT (
  part_number varchar2(32767),
  name varchar2(32767),
  unit_of_measure varchar2(32767),
  provisioning_group varchar2(32767),
  billing_category varchar2(32767),
  product_category varchar2(32767),
  ucm_rate_card_part_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_product_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_product_t (
    part_number varchar2,
    name varchar2,
    unit_of_measure varchar2,
    provisioning_group varchar2,
    billing_category varchar2,
    product_category varchar2,
    ucm_rate_card_part_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

part_number

(required) Product part number

name

(required) Product name

unit_of_measure

(optional) Unit of Measure

provisioning_group

(optional) Product provisioning group

billing_category

(optional) Metered service billing category

product_category

(optional) Product category

ucm_rate_card_part_type

(optional) Rate card part type of Product

DBMS_CLOUD_OCI_OSUB_USAGE_COMPUTED_USAGE_T Type

Computed Usage Summary object

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osub_usage_computed_usage_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  parent_subscribed_service_id varchar2(32767),
  parent_product dbms_cloud_oci_osub_usage_product_t,
  plan_number varchar2(32767),
  currency_code varchar2(32767),
  rate_card_tierd_id varchar2(32767),
  rate_card_id varchar2(32767),
  compute_source varchar2(32767),
  data_center varchar2(32767),
  mqs_message_id varchar2(32767),
  id varchar2(32767),
  quantity varchar2(32767),
  usage_number varchar2(32767),
  original_usage_number varchar2(32767),
  commitment_service_id varchar2(32767),
  is_invoiced number,
  l_type varchar2(32767),
  time_of_arrival timestamp with time zone,
  time_metered_on timestamp with time zone,
  net_unit_price varchar2(32767),
  cost_rounded varchar2(32767),
  cost varchar2(32767),
  product dbms_cloud_oci_osub_usage_product_t,
  unit_of_measure varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_computed_usage_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_computed_usage_t (
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    parent_subscribed_service_id varchar2,
    parent_product dbms_cloud_oci_osub_usage_product_t,
    plan_number varchar2,
    currency_code varchar2,
    rate_card_tierd_id varchar2,
    rate_card_id varchar2,
    compute_source varchar2,
    data_center varchar2,
    mqs_message_id varchar2,
    id varchar2,
    quantity varchar2,
    usage_number varchar2,
    original_usage_number varchar2,
    commitment_service_id varchar2,
    is_invoiced number,
    l_type varchar2,
    time_of_arrival timestamp with time zone,
    time_metered_on timestamp with time zone,
    net_unit_price varchar2,
    cost_rounded varchar2,
    cost varchar2,
    product dbms_cloud_oci_osub_usage_product_t,
    unit_of_measure varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_created

(optional) Computed Usage created time, expressed in RFC 3339 timestamp format.

time_updated

(optional) Computed Usage updated time, expressed in RFC 3339 timestamp format.

parent_subscribed_service_id

(optional) Subscribed service line parent id

parent_product

(optional)

plan_number

(optional) Subscription plan number

currency_code

(optional) Currency code

rate_card_tierd_id

(optional) References the tier in the ratecard for that usage (OCI will be using the same reference to cross-reference for correctness on the usage csv report), comes from Entity OBSCNTR_IPT_PRODUCTTIER.

rate_card_id

(optional) Ratecard Id at subscribed service level

compute_source

(optional) SPM Internal compute records source .

data_center

(optional) Data Center Attribute as sent by MQS to SPM.

mqs_message_id

(optional) MQS Identfier send to SPM , SPM does not transform this attribute and is received as is.

id

(required) SPM Internal computed usage Id , 32 character string

quantity

(optional) Total Quantity that was used for computation

usage_number

(optional) SPM Internal usage Line number identifier in SPM coming from Metered Services entity.

original_usage_number

(optional) SPM Internal Original usage Line number identifier in SPM coming from Metered Services entity.

commitment_service_id

(optional) Subscribed service commitmentId.

is_invoiced

(optional) Invoicing status for the aggregated compute usage

l_type

(optional) Usage compute type in SPM.

Allowed values are: 'PROMOTION', 'DO_NOT_BILL', 'USAGE', 'COMMIT', 'OVERAGE', 'PAY_AS_YOU_GO', 'MONTHLY_MINIMUM', 'DELAYED_USAGE_INVOICE_TIMING', 'DELAYED_USAGE_COMMITMENT_EXP', 'ON_ACCOUNT_CREDIT', 'SERVICE_CREDIT', 'COMMITMENT_EXPIRATION', 'FUNDED_ALLOCATION', 'DONOT_BILL_USAGE_POST_TERMINATION', 'DELAYED_USAGE_POST_TERMINATION'

time_of_arrival

(optional) Usae computation date, expressed in RFC 3339 timestamp format.

time_metered_on

(optional) Metered Service date, expressed in RFC 3339 timestamp format.

net_unit_price

(optional) Net Unit Price for the product in consideration, price actual.

cost_rounded

(optional) Computed Line Amount rounded.

cost

(optional) Computed Line Amount not rounded

product

(optional)

unit_of_measure

(optional) Unit of Messure

DBMS_CLOUD_OCI_OSUB_USAGE_COMPUTED_USAGE_AGGREGATION_T Type

Computed Usage Aggregation object

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osub_usage_computed_usage_aggregation_t FORCE AUTHID CURRENT_USER IS OBJECT (
  quantity varchar2(32767),
  product dbms_cloud_oci_osub_usage_product_t,
  data_center varchar2(32767),
  time_metered_on timestamp with time zone,
  net_unit_price varchar2(32767),
  cost_unrounded varchar2(32767),
  cost varchar2(32767),
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_computed_usage_aggregation_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_computed_usage_aggregation_t (
    quantity varchar2,
    product dbms_cloud_oci_osub_usage_product_t,
    data_center varchar2,
    time_metered_on timestamp with time zone,
    net_unit_price varchar2,
    cost_unrounded varchar2,
    cost varchar2,
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

quantity

(optional) Total Quantity that was used for computation

product

(optional)

data_center

(optional) Data Center Attribute as sent by MQS to SPM.

time_metered_on

(optional) Metered Service date , expressed in RFC 3339 timestamp format.

net_unit_price

(optional) Net Unit Price for the product in consideration.

cost_unrounded

(optional) Sum of Computed Line Amount unrounded

cost

(optional) Sum of Computed Line Amount rounded

l_type

(optional) Usage compute type in SPM.

Allowed values are: 'PROMOTION', 'DO_NOT_BILL', 'USAGE', 'COMMIT', 'OVERAGE', 'PAY_AS_YOU_GO', 'MONTHLY_MINIMUM', 'DELAYED_USAGE_INVOICE_TIMING', 'DELAYED_USAGE_COMMITMENT_EXP', 'ON_ACCOUNT_CREDIT', 'SERVICE_CREDIT', 'COMMITMENT_EXPIRATION', 'FUNDED_ALLOCATION', 'DONOT_BILL_USAGE_POST_TERMINATION', 'DELAYED_USAGE_POST_TERMINATION'

DBMS_CLOUD_OCI_OSUB_USAGE_COMPUTED_USAGE_AGGREGATION_TBL Type

Nested table type of dbms_cloud_oci_osub_usage_computed_usage_aggregation_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osub_usage_computed_usage_aggregation_tbl FORCE IS TABLE OF (dbms_cloud_oci_osub_usage_computed_usage_aggregation_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OSUB_USAGE_COMPUTED_USAGE_AGGREGATED_SUMMARY_T Type

Subscribed Service Contract details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osub_usage_computed_usage_aggregated_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subscription_id varchar2(32767),
  parent_subscribed_service_id varchar2(32767),
  parent_product dbms_cloud_oci_osub_usage_product_t,
  time_start timestamp with time zone,
  time_end timestamp with time zone,
  plan_number varchar2(32767),
  currency_code varchar2(32767),
  rate_card_id varchar2(32767),
  pricing_model varchar2(32767),
  aggregated_computed_usages dbms_cloud_oci_osub_usage_computed_usage_aggregation_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_computed_usage_aggregated_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_computed_usage_aggregated_summary_t (
    subscription_id varchar2,
    parent_subscribed_service_id varchar2,
    parent_product dbms_cloud_oci_osub_usage_product_t,
    time_start timestamp with time zone,
    time_end timestamp with time zone,
    plan_number varchar2,
    currency_code varchar2,
    rate_card_id varchar2,
    pricing_model varchar2,
    aggregated_computed_usages dbms_cloud_oci_osub_usage_computed_usage_aggregation_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subscription_id

(required) Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM

parent_subscribed_service_id

(optional) Subscribed service line parent id

parent_product

(optional)

time_start

(optional) Subscribed services contract line start date, expressed in RFC 3339 timestamp format.

time_end

(optional) Subscribed services contract line end date, expressed in RFC 3339 timestamp format.

plan_number

(optional) Subscribed service asociated subscription plan number.

currency_code

(optional) Currency code

rate_card_id

(optional) Inernal SPM Ratecard Id at line level

pricing_model

(optional) Subscribed services pricing model

Allowed values are: 'PAY_AS_YOU_GO', 'MONTHLY', 'ANNUAL', 'PREPAID', 'FUNDED_ALLOCATION'

aggregated_computed_usages

(optional) Aggregation of computed usages for the subscribed service.

DBMS_CLOUD_OCI_OSUB_USAGE_COMPUTED_USAGE_SUMMARY_T Type

Computed Usage Summary object

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osub_usage_computed_usage_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  parent_subscribed_service_id varchar2(32767),
  parent_product dbms_cloud_oci_osub_usage_product_t,
  plan_number varchar2(32767),
  currency_code varchar2(32767),
  rate_card_tierd_id varchar2(32767),
  rate_card_id varchar2(32767),
  compute_source varchar2(32767),
  data_center varchar2(32767),
  mqs_message_id varchar2(32767),
  computed_usage_id varchar2(32767),
  quantity varchar2(32767),
  usage_number varchar2(32767),
  original_usage_number varchar2(32767),
  commitment_service_id varchar2(32767),
  is_invoiced number,
  l_type varchar2(32767),
  time_of_arrival timestamp with time zone,
  time_metered_on timestamp with time zone,
  net_unit_price varchar2(32767),
  cost_rounded varchar2(32767),
  cost varchar2(32767),
  product dbms_cloud_oci_osub_usage_product_t,
  unit_of_measure varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_computed_usage_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_computed_usage_summary_t (
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    parent_subscribed_service_id varchar2,
    parent_product dbms_cloud_oci_osub_usage_product_t,
    plan_number varchar2,
    currency_code varchar2,
    rate_card_tierd_id varchar2,
    rate_card_id varchar2,
    compute_source varchar2,
    data_center varchar2,
    mqs_message_id varchar2,
    computed_usage_id varchar2,
    quantity varchar2,
    usage_number varchar2,
    original_usage_number varchar2,
    commitment_service_id varchar2,
    is_invoiced number,
    l_type varchar2,
    time_of_arrival timestamp with time zone,
    time_metered_on timestamp with time zone,
    net_unit_price varchar2,
    cost_rounded varchar2,
    cost varchar2,
    product dbms_cloud_oci_osub_usage_product_t,
    unit_of_measure varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_created

(optional) Computed Usage created time, expressed in RFC 3339 timestamp format.

time_updated

(optional) Computed Usage updated time, expressed in RFC 3339 timestamp format.

parent_subscribed_service_id

(optional) Subscribed service line parent id

parent_product

(optional)

plan_number

(optional) Subscription plan number

currency_code

(optional) Currency code

rate_card_tierd_id

(optional) References the tier in the ratecard for that usage (OCI will be using the same reference to cross-reference for correctness on the usage csv report), comes from Entity OBSCNTR_IPT_PRODUCTTIER.

rate_card_id

(optional) Ratecard Id at subscribed service level

compute_source

(optional) SPM Internal compute records source .

data_center

(optional) Data Center Attribute as sent by MQS to SPM.

mqs_message_id

(optional) MQS Identfier send to SPM , SPM does not transform this attribute and is received as is.

computed_usage_id

(required) SPM Internal computed usage Id , 32 character string

quantity

(optional) Total Quantity that was used for computation

usage_number

(optional) SPM Internal usage Line number identifier in SPM coming from Metered Services entity.

original_usage_number

(optional) SPM Internal Original usage Line number identifier in SPM coming from Metered Services entity.

commitment_service_id

(optional) Subscribed service commitmentId.

is_invoiced

(optional) Invoicing status for the aggregated compute usage

l_type

(optional) Usage compute type in SPM.

Allowed values are: 'PROMOTION', 'DO_NOT_BILL', 'USAGE', 'COMMIT', 'OVERAGE', 'PAY_AS_YOU_GO', 'MONTHLY_MINIMUM', 'DELAYED_USAGE_INVOICE_TIMING', 'DELAYED_USAGE_COMMITMENT_EXP', 'ON_ACCOUNT_CREDIT', 'SERVICE_CREDIT', 'COMMITMENT_EXPIRATION', 'FUNDED_ALLOCATION', 'DONOT_BILL_USAGE_POST_TERMINATION', 'DELAYED_USAGE_POST_TERMINATION'

time_of_arrival

(optional) Usae computation date, expressed in RFC 3339 timestamp format.

time_metered_on

(optional) Metered Service date, expressed in RFC 3339 timestamp format.

net_unit_price

(optional) Net Unit Price for the product in consideration, price actual.

cost_rounded

(optional) Computed Line Amount rounded.

cost

(optional) Computed Line Amount not rounded

product

(optional)

unit_of_measure

(optional) Unit of Messure

DBMS_CLOUD_OCI_OSUB_USAGE_ERROR_T Type

Internal error object model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osub_usage_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osub_usage_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

Was this article helpful?