Skip to content

ConnectHealth  >  Operations  >  activate_subscription

activate_subscription

Operation

activate_subscription async 

activate_subscription(input: ActivateSubscriptionInput, plugins: list[Plugin] | None = None) -> ActivateSubscriptionOutput

Activates a Subscription to enable billing for a user.

Parameters:

Name Type Description Default
input ActivateSubscriptionInput

An instance of ActivateSubscriptionInput.

 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
ActivateSubscriptionOutput

An instance of ActivateSubscriptionOutput.

Input

ActivateSubscriptionInput dataclass

Dataclass for ActivateSubscriptionInput 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

ActivateSubscriptionOutput dataclass

Dataclass for ActivateSubscriptionOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

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