IoTTwinMaker / Client / get_pricing_plan

get_pricing_plan#

IoTTwinMaker.Client.get_pricing_plan()#

Gets the pricing plan.

Request Syntax

response = client.get_pricing_plan()

Return type:

dict

Returns:

Response Syntax

{
    'currentPricingPlan': {
        'billableEntityCount': 123,
        'bundleInformation': {
            'bundleNames': [
                'string',
            ],
            'pricingTier': 'TIER_1'|'TIER_2'|'TIER_3'|'TIER_4'
        },
        'effectiveDateTime': datetime(2015, 1, 1),
        'pricingMode': 'BASIC'|'STANDARD'|'TIERED_BUNDLE',
        'updateDateTime': datetime(2015, 1, 1),
        'updateReason': 'DEFAULT'|'PRICING_TIER_UPDATE'|'ENTITY_COUNT_UPDATE'|'PRICING_MODE_UPDATE'|'OVERWRITTEN'
    },
    'pendingPricingPlan': {
        'billableEntityCount': 123,
        'bundleInformation': {
            'bundleNames': [
                'string',
            ],
            'pricingTier': 'TIER_1'|'TIER_2'|'TIER_3'|'TIER_4'
        },
        'effectiveDateTime': datetime(2015, 1, 1),
        'pricingMode': 'BASIC'|'STANDARD'|'TIERED_BUNDLE',
        'updateDateTime': datetime(2015, 1, 1),
        'updateReason': 'DEFAULT'|'PRICING_TIER_UPDATE'|'ENTITY_COUNT_UPDATE'|'PRICING_MODE_UPDATE'|'OVERWRITTEN'
    }
}

Response Structure

(dict) –
- currentPricingPlan (dict) –
  
  The chosen pricing plan for the current billing cycle.
  - billableEntityCount (integer) –
    
    The billable entity count.
  - bundleInformation (dict) –
    
    The pricing plan’s bundle information.
    - bundleNames (list) –
      
      The bundle names.
      - (string) –
    - pricingTier (string) –
      
      The pricing tier.
  - effectiveDateTime (datetime) –
    
    The effective date and time of the pricing plan.
  - pricingMode (string) –
    
    The pricing mode.
  - updateDateTime (datetime) –
    
    The set date and time for updating a pricing plan.
  - updateReason (string) –
    
    The update reason for changing a pricing plan.
- pendingPricingPlan (dict) –
  
  The pending pricing plan.
  - billableEntityCount (integer) –
    
    The billable entity count.
  - bundleInformation (dict) –
    
    The pricing plan’s bundle information.
    - bundleNames (list) –
      
      The bundle names.
      - (string) –
    - pricingTier (string) –
      
      The pricing tier.
  - effectiveDateTime (datetime) –
    
    The effective date and time of the pricing plan.
  - pricingMode (string) –
    
    The pricing mode.
  - updateDateTime (datetime) –
    
    The set date and time for updating a pricing plan.
  - updateReason (string) –
    
    The update reason for changing a pricing plan.

Exceptions

IoTTwinMaker.Client.exceptions.InternalServerException
IoTTwinMaker.Client.exceptions.AccessDeniedException
IoTTwinMaker.Client.exceptions.ThrottlingException
IoTTwinMaker.Client.exceptions.ValidationException