Connecthealth  >  Operations  >  deactivate_subscription

deactivate_subscription

Operation

deactivate_subscription async

deactivate_subscription(input: DeactivateSubscriptionInput, plugins: list[Plugin] | None = None) -> DeactivateSubscriptionOutput

Deactivates a Subscription to stop billing for a user.

Parameters:

Name	Type	Description	Default
input	DeactivateSubscriptionInput	An instance of DeactivateSubscriptionInput.	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
DeactivateSubscriptionOutput	An instance of DeactivateSubscriptionOutput.

Input

DeactivateSubscriptionInput dataclass

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

DeactivateSubscriptionOutput dataclass

Dataclass for DeactivateSubscriptionOutput structure.

Attributes

subscription class-attribute instance-attribute

subscription: SubscriptionDescription | None = None