Usage Rewards Functions

Package: DBMS_CLOUD_OCI_US_REWARDS

CREATE_REDEEMABLE_USER Function

Adds the list of redeemable user summary for a subscription ID.

Syntax

FUNCTION create_redeemable_user (
  create_redeemable_user_details dbms_cloud_oci_usage_create_redeemable_user_details_t,
  tenancy_id varchar2,
  subscription_id varchar2,
  user_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_us_rewards_create_redeemable_user_response_t;

Parameters

Parameter	Description
`create_redeemable_user_details`	(required) CreateRedeemableUserDetails information.
`tenancy_id`	(required) The OCID of the tenancy.
`subscription_id`	(required) The subscription ID for which rewards information is requested for.
`user_id`	(optional) The user ID of the person to send a copy of an email.
`opc_request_id`	(optional) Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted, only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://identity.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REDEEMABLE_USER Function

Deletes the list of redeemable user email ID for a subscription ID.

Syntax

FUNCTION delete_redeemable_user (
  email_id varchar2,
  tenancy_id varchar2,
  subscription_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_us_rewards_delete_redeemable_user_response_t;

Parameters

Parameter	Description
`email_id`	(required) The email ID that needs to be deleted.
`tenancy_id`	(required) The OCID of the tenancy.
`subscription_id`	(required) The subscription ID for which rewards information is requested for.
`opc_request_id`	(optional) Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted, only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://identity.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PRODUCTS Function

Provides product information that is specific to a reward usage period and its usage details.

Syntax

FUNCTION list_products (
  tenancy_id varchar2,
  subscription_id varchar2,
  usage_period_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  producttype varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_us_rewards_list_products_response_t;

Parameters

Parameter	Description
`tenancy_id`	(required) The OCID of the tenancy.
`subscription_id`	(required) The subscription ID for which rewards information is requested for.
`usage_period_key`	(required) The SPM Identifier for the usage period.
`opc_request_id`	(optional) Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`page`	(optional) The value of the 'opc-next-page' response header from the previous call.
`limit`	(optional) The maximum number of items to return in the paginated response.
`sort_order`	(optional) The sort order to use, which can be ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Supports one sort order. Allowed values are: 'TIMECREATED', 'TIMESTART'
`producttype`	(optional) The field to specify the type of product. Allowed values are: 'ALL', 'ELIGIBLE', 'INELIGIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://identity.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REDEEMABLE_USERS Function

Provides the list of user summary that can redeem rewards for the given subscription ID.

Syntax

FUNCTION list_redeemable_users (
  tenancy_id varchar2,
  subscription_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_us_rewards_list_redeemable_users_response_t;

Parameters

Parameter	Description
`tenancy_id`	(required) The OCID of the tenancy.
`subscription_id`	(required) The subscription ID for which rewards information is requested for.
`opc_request_id`	(optional) Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`page`	(optional) The value of the 'opc-next-page' response header from the previous call.
`limit`	(optional) The maximum number of items to return in the paginated response.
`sort_order`	(optional) The sort order to use, which can be ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Supports one sort order. Allowed values are: 'TIMECREATED', 'TIMESTART'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://identity.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REDEMPTIONS Function

Returns the list of redemption for the subscription ID.

Syntax

FUNCTION list_redemptions (
  tenancy_id varchar2,
  subscription_id varchar2,
  time_redeemed_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_redeemed_less_than timestamp with time zone DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_us_rewards_list_redemptions_response_t;

Parameters

Parameter	Description
`tenancy_id`	(required) The OCID of the tenancy.
`subscription_id`	(required) The subscription ID for which rewards information is requested for.
`time_redeemed_greater_than_or_equal_to`	(optional) The starting redeemed date filter for the redemption history.
`time_redeemed_less_than`	(optional) The ending redeemed date filter for the redemption history.
`opc_request_id`	(optional) Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`page`	(optional) The value of the 'opc-next-page' response header from the previous call.
`limit`	(optional) The maximum number of items to return in the paginated response.
`sort_order`	(optional) The sort order to use, which can be ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to be used only for list redemptions API. Supports one sort order. Allowed values are: 'TIMEREDEEMED'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://identity.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REWARDS Function

Returns the list of rewards for a subscription ID.

Syntax

FUNCTION list_rewards (
  tenancy_id varchar2,
  subscription_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_us_rewards_list_rewards_response_t;

Parameters

Parameter	Description
`tenancy_id`	(required) The OCID of the tenancy.
`subscription_id`	(required) The subscription ID for which rewards information is requested for.
`opc_request_id`	(optional) Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://identity.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CREATE_REDEEMABLE_USER Function 🔗

DELETE_REDEEMABLE_USER Function 🔗

LIST_PRODUCTS Function 🔗

LIST_REDEEMABLE_USERS Function 🔗

LIST_REDEMPTIONS Function 🔗

LIST_REWARDS Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CREATE_REDEEMABLE_USER Function

DELETE_REDEEMABLE_USER Function

LIST_PRODUCTS Function

LIST_REDEEMABLE_USERS Function

LIST_REDEMPTIONS Function

LIST_REWARDS Function