Class SubscriptionClient

Service client instance for Subscription.

Inheritance

object

ClientBase

RegionalClientBase

SubscriptionClient

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)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OnesubscriptionService

Assembly: OCI.DotNetSDK.Onesubscription.dll

Syntax

public class SubscriptionClient : RegionalClientBase, IDisposable

Constructors

SubscriptionClient(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 SubscriptionClient(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 SubscriptionPaginators Paginators { get; }

Property Value

Type	Description
SubscriptionPaginators

Methods

GetSubscriptionDetails(GetSubscriptionDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the commitment summary for a subscription.

Declaration

public Task<GetSubscriptionDetailsResponse> GetSubscriptionDetails(GetSubscriptionDetailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSubscriptionDetailsRequest	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<GetSubscriptionDetailsResponse>	A response object containing details about the completed operation

Examples

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

ListSubscriptions(ListSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns all subscriptions for a given plan number, subscription ID, or buyer email, and provides additional parameters, to include rate card and commitment details. Exactly one of the these parameters is expected as input. If more than one parameter is provided, a 400 - invalid parameters exception is thrown, and if no parameters are provided, a 400 - missing parameter exception is thrown.

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.

ListUsageLedgers(ListUsageLedgersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns revenue invoice consumption details for authorization orders that draw down from the requested subscription. It includes authorization-order subscription IDs but excludes the requested subscription ID itself.

Declaration

public Task<ListUsageLedgersResponse> ListUsageLedgers(ListUsageLedgersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUsageLedgersRequest	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<ListUsageLedgersResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable