Class SubscriptionServiceClient

Service client instance for SubscriptionService.

Inheritance

object

ClientBase

RegionalClientBase

SubscriptionServiceClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OspgatewayService

Assembly: OCI.DotNetSDK.Ospgateway.dll

Syntax

public class SubscriptionServiceClient : RegionalClientBase, IDisposable

Constructors

SubscriptionServiceClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public SubscriptionServiceClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public SubscriptionServicePaginators Paginators { get; }

Property Value

Type	Description
SubscriptionServicePaginators

Methods

AuthorizeSubscriptionPayment(AuthorizeSubscriptionPaymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

PSD2 authorization for subscription payment

Declaration

public Task<AuthorizeSubscriptionPaymentResponse> AuthorizeSubscriptionPayment(AuthorizeSubscriptionPaymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AuthorizeSubscriptionPaymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AuthorizeSubscriptionPaymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AuthorizeSubscriptionPayment API.

GetSubscription(GetSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the subscription plan.

Declaration

public Task<GetSubscriptionResponse> GetSubscription(GetSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSubscriptionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSubscriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSubscription API.

ListSubscriptions(ListSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the subscription data for the compartment

Declaration

public Task<ListSubscriptionsResponse> ListSubscriptions(ListSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSubscriptionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSubscriptionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSubscriptions API.

PaySubscription(PaySubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Pay a subscription

Declaration

public Task<PaySubscriptionResponse> PaySubscription(PaySubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PaySubscriptionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PaySubscriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PaySubscription API.

UpdateSubscription(UpdateSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update plan of the subscription.

Declaration

public Task<UpdateSubscriptionResponse> UpdateSubscription(UpdateSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSubscriptionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSubscriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSubscription API.

Implements

IDisposable