ConnectHealth / Client / deactivate_subscription

deactivate_subscription

ConnectHealth.Client.deactivate_subscription(**kwargs)

Deactivates a Subscription to stop billing for a user.

See also: AWS API Documentation

Request Syntax

response = client.deactivate_subscription(
    domainId='string',
    subscriptionId='string'
)
Parameters:

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the parent Domain.

  • subscriptionId (string) –

    [REQUIRED]

    The unique identifier of the Subscription.

Return type:

dict

Returns:

Response Syntax

{
    'subscription': {
        'domainId': 'string',
        'subscriptionId': 'string',
        'arn': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DELETED',
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'activatedAt': datetime(2015, 1, 1),
        'deactivatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • subscription (dict) –

      • domainId (string) –

      • subscriptionId (string) –

      • arn (string) –

      • status (string) –

      • createdAt (datetime) –

      • lastUpdatedAt (datetime) –

      • activatedAt (datetime) –

      • deactivatedAt (datetime) –

Exceptions