CodeCatalyst / Client / get_subscription

get_subscription#

CodeCatalyst.Client.get_subscription(**kwargs)#

Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

See also: AWS API Documentation

Request Syntax

response = client.get_subscription(
    spaceName='string'
)
Parameters:

spaceName (string) –

[REQUIRED]

The name of the space.

Return type:

dict

Returns:

Response Syntax

{
    'subscriptionType': 'string',
    'awsAccountName': 'string',
    'pendingSubscriptionType': 'string',
    'pendingSubscriptionStartTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • subscriptionType (string) –

      The type of the billing plan for the space.

    • awsAccountName (string) –

      The display name of the Amazon Web Services account used for billing for the space.

    • pendingSubscriptionType (string) –

      The type of the billing plan that the space will be changed to at the start of the next billing cycle. This applies only to changes that reduce the functionality available for the space. Billing plan changes that increase functionality are applied immediately. For more information, see Pricing.

    • pendingSubscriptionStartTime (datetime) –

      The day and time the pending change will be applied to the space, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

Exceptions