Skip to content

Connecthealth  >  Operations  >  get_subscription

get_subscription

Operation

get_subscription async

get_subscription(input: GetSubscriptionInput, plugins: list[Plugin] | None = None) -> GetSubscriptionOutput

Retrieves information about a Subscription.

Parameters:

Name Type Description Default
input GetSubscriptionInput

An instance of GetSubscriptionInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetSubscriptionOutput

An instance of GetSubscriptionOutput.

Input

GetSubscriptionInput dataclass

Dataclass for GetSubscriptionInput structure.

Attributes

domain_id class-attribute instance-attribute
domain_id: str | None = None

The unique identifier of the parent Domain.

subscription_id class-attribute instance-attribute
subscription_id: str | None = None

The unique identifier of the Subscription.

Output

GetSubscriptionOutput dataclass

Dataclass for GetSubscriptionOutput structure.

Attributes

subscription class-attribute instance-attribute
subscription: SubscriptionDescription | None = None