Oracle Cloud Infrastructure Documentation

OSP Gateway Subscription Service Functions

Package: DBMS_CLOUD_OCI_OG_SUBSCRIPTION_SERVICE

AUTHORIZE_SUBSCRIPTION_PAYMENT Function

PSD2 authorization for subscription payment

Syntax

FUNCTION authorize_subscription_payment (
  osp_home_region varchar2,
  subscription_id varchar2,
  compartment_id varchar2,
  authorize_subscription_payment_details dbms_cloud_oci_osp_gateway_authorize_subscription_payment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_og_subscription_service_authorize_subscription_payment_response_t;

Parameters

Parameter Description

osp_home_region

(required) The home region's public name of the logged in user.

subscription_id

(required) Subscription id(OCID).

compartment_id

(required) The OCID of the compartment.

authorize_subscription_payment_details

(required) subscription payment request.

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) For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.

opc_request_id

(optional) The 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://ospap.oracle.com.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.

GET_SUBSCRIPTION Function

Get the subscription plan.

Syntax

FUNCTION get_subscription (
  subscription_id varchar2,
  osp_home_region varchar2,
  compartment_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_og_subscription_service_get_subscription_response_t;

Parameters

Parameter Description

subscription_id

(required) Subscription id(OCID).

osp_home_region

(required) The home region's public name of the logged in user.

compartment_id

(required) The OCID of the compartment.

opc_request_id

(optional) The 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://ospap.oracle.com.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_SUBSCRIPTIONS Function

Get the subscription data for the compartment

Syntax

FUNCTION list_subscriptions (
  osp_home_region varchar2,
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_og_subscription_service_list_subscriptions_response_t;

Parameters

Parameter Description

osp_home_region

(required) The home region's public name of the logged in user.

compartment_id

(required) The OCID of the compartment.

opc_request_id

(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

page

(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call.

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.

sort_by

(optional) The field to sort by. Only one field can be selected for sorting.

Allowed values are: 'INVOICE_NO', 'REF_NO', 'STATUS', 'TYPE', 'INVOICE_DATE', 'DUE_DATE', 'PAYM_REF', 'TOTAL_AMOUNT', 'BALANCE_DUE'

sort_order

(optional) The sort order to use (ascending or descending).

Allowed values are: 'ASC', 'DESC'

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://ospap.oracle.com.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.

PAY_SUBSCRIPTION Function

Pay a subscription

Syntax

FUNCTION pay_subscription (
  osp_home_region varchar2,
  subscription_id varchar2,
  compartment_id varchar2,
  pay_subscription_details dbms_cloud_oci_osp_gateway_pay_subscription_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_og_subscription_service_pay_subscription_response_t;

Parameters

Parameter Description

osp_home_region

(required) The home region's public name of the logged in user.

subscription_id

(required) Subscription id(OCID).

compartment_id

(required) The OCID of the compartment.

pay_subscription_details

(required) subscription payment request.

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) For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.

opc_request_id

(optional) The 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://ospap.oracle.com.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.

UPDATE_SUBSCRIPTION Function

Update plan of the subscription.

Syntax

FUNCTION update_subscription (
  subscription_id varchar2,
  osp_home_region varchar2,
  compartment_id varchar2,
  update_subscription_details dbms_cloud_oci_osp_gateway_update_subscription_details_t,
  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_og_subscription_service_update_subscription_response_t;

Parameters

Parameter Description

subscription_id

(required) Subscription id(OCID).

osp_home_region

(required) The home region's public name of the logged in user.

compartment_id

(required) The OCID of the compartment.

update_subscription_details

(required) Subscription update request.

opc_request_id

(optional) The 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://ospap.oracle.com.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.