Skip to content

deactivate_subscription

Operation

deactivate_subscription

deactivate_subscription(request: DeactivateSubscriptionInput | DeactivateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeactivateSubscriptionInputDict]) -> DeactivateSubscriptionOutput

Deactivates a Subscription to stop billing for a user.

Parameters:

Name Type Description Default
request DeactivateSubscriptionInput | DeactivateSubscriptionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeactivateSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeactivateSubscriptionOutput

An instance of DeactivateSubscriptionOutput.

deactivate_subscription async

deactivate_subscription(request: DeactivateSubscriptionInput | DeactivateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeactivateSubscriptionInputDict]) -> DeactivateSubscriptionOutput

Deactivates a Subscription to stop billing for a user.

Parameters:

Name Type Description Default
request DeactivateSubscriptionInput | DeactivateSubscriptionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeactivateSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeactivateSubscriptionOutput

An instance of DeactivateSubscriptionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeactivateSubscriptionInputDict

Bases: TypedDict

Dictionary form of DeactivateSubscriptionInput.

Attributes

domain_id instance-attribute
domain_id: Required[str]

The unique identifier of the parent Domain.

subscription_id instance-attribute
subscription_id: Required[str]

The unique identifier of the Subscription.

DeactivateSubscriptionInput dataclass

Bases: _SerdeShape

Dataclass for DeactivateSubscriptionInput structure.

Attributes

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

The unique identifier of the parent Domain.

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

The unique identifier of the Subscription.

Output

DeactivateSubscriptionOutput dataclass

Bases: _SerdeShape

Dataclass for DeactivateSubscriptionOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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 = ...