Skip to content

activate_subscription

Operation

activate_subscription

activate_subscription(request: ActivateSubscriptionInput | ActivateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ActivateSubscriptionInputDict]) -> ActivateSubscriptionOutput

Activates a Subscription to enable billing for a user.

Parameters:

Name Type Description Default
request ActivateSubscriptionInput | ActivateSubscriptionInputDict | 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[ActivateSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ActivateSubscriptionOutput

An instance of ActivateSubscriptionOutput.

activate_subscription async

activate_subscription(request: ActivateSubscriptionInput | ActivateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ActivateSubscriptionInputDict]) -> ActivateSubscriptionOutput

Activates a Subscription to enable billing for a user.

Parameters:

Name Type Description Default
request ActivateSubscriptionInput | ActivateSubscriptionInputDict | 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[ActivateSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ActivateSubscriptionOutput

An instance of ActivateSubscriptionOutput.

Input

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

ActivateSubscriptionInputDict

Bases: TypedDict

Dictionary form of ActivateSubscriptionInput.

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.

ActivateSubscriptionInput dataclass

Bases: _SerdeShape

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

ActivateSubscriptionOutput dataclass

Bases: _SerdeShape

Dataclass for ActivateSubscriptionOutput 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 = ...