Billing / Client / get_enterprise_support_contract_details

get_enterprise_support_contract_details¶

Billing.Client.get_enterprise_support_contract_details(**kwargs)¶

Returns Enterprise Support contract details.

Request Syntax

response = client.get_enterprise_support_contract_details(
    billingMonth='string'
)

Parameters:

billingMonth (string) –

[REQUIRED]

The billing month in YYYY-MM format. This must be a month in the past.

Return type:

dict

Returns:

Response Syntax

{
    'isContractActive': True|False,
    'supportAllocationMethod': 'string',
    'supportReservedInstanceAmortizationStartDate': datetime(2015, 1, 1),
    'supportReservedInstanceTreatmentMethod': 'string',
    'supportSavingsPlansAmortizationStartDate': datetime(2015, 1, 1),
    'supportSavingsPlansTreatmentMethod': 'string',
    'supportProrateStartDate': datetime(2015, 1, 1),
    'contractPayerAccountIds': [
        {
            'accountId': 'string',
            'isGdn': True|False
        },
    ],
    'chargedPayerAccountIds': [
        {
            'accountId': 'string',
            'chargePercentage': 'string'
        },
    ],
    'additionalSupportCharge': [
        {
            'description': 'string',
            'amount': 'string',
            'chargeType': 'string'
        },
    ],
    'additionalSupportEligibleUsageSpend': [
        {
            'description': 'string',
            'amount': 'string',
            'chargeType': 'string'
        },
    ],
    'pricingPlans': [
        {
            'pricingPlanId': 'string',
            'name': 'string',
            'description': 'string',
            'startDate': datetime(2015, 1, 1),
            'endDate': datetime(2015, 1, 1),
            'planDiscountPercent': 'string',
            'discountAppliesToMinimumCharge': True|False,
            'minimumCharge': 'string',
            'tiered': 'string',
            'tiers': [
                {
                    'tierMinimum': 'string',
                    'tierMaximum': 'string',
                    'baseCharge': 'string',
                    'additionalPercentageOfAggregateCharges': 'string',
                    'aggregateChargesAdjustment': 'string',
                    'incremental': True|False,
                    'increment': 'string',
                    'incrementCharge': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –

The response structure for GetEnterpriseSupportContractDetails.
- isContractActive (boolean) –
  
  When true, the Enterprise Support contract is active. When false, the Enterprise Support Contract is inactive.
- supportAllocationMethod (string) –
  
  The method used to distribute the total Support charge amount across each account in the Support profile. Valid values: Proportional, Fixed_Percentage. Proportional means support charges are distributed to each account in proportion to its eligible Spend. Fixed_Percentage means support charges are distributed across accounts according to pre-configured percentages from the contract.
- supportReservedInstanceAmortizationStartDate (datetime) –
  
  When supportReservedInstanceTreatmentMethod = AmortizedCustom, only amortized fees for Reserved Instances purchased on or after this date are included in the calculation. This field is Null for all other treatment methods.
- supportReservedInstanceTreatmentMethod (string) –
  
  The method used to include Reserved Instance (RI) fees in the Enterprise Support charge calculation. Valid values: None (RI fees excluded from Support-eligible spend), Upfront (full upfront RI fees included in month of purchase), Amortized (RI fees spread over commitment term for RIs purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for RIs purchased on or after a specified custom start date), AmortizedAll (RI fees amortized for all active RIs including those purchased before Support subscription started).
- supportSavingsPlansAmortizationStartDate (datetime) –
  
  This is applicable when supportSavingsPlansTreatmentMethod = Amortized and is Null for all other methods. It shows the start date from which Savings Plan fees are included in Support Eligible Spend.
- supportSavingsPlansTreatmentMethod (string) –
  
  The method used to include Savings Plans fees in Enterprise Support charge calculations. Valid values: None (Savings Plan fees excluded from Support-eligible spend), Upfront (full upfront Savings Plan fees included in month of purchase), Amortized (Savings Plan fees spread over commitment term for Savings Plans purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for Savings Plans purchased on or after a specified custom start date), AmortizedAll (Savings Plan fees amortized for all active Savings Plans including those purchased before Support subscription started).
- supportProrateStartDate (datetime) –
  
  The start date for accounts subscribed or unsubscribed to Support billing during the billing month.
- contractPayerAccountIds (list) –
  
  The list of accounts covered by the Enterprise Support contract.
  - (dict) –
    
    An account that is covered by the Enterprise Support contract.
    - accountId (string) –
      
      The account ID.
    - isGdn (boolean) –
      
      When true, Support charges are calculated on charges before private discounts. When false, they are calculated after private discounts.
- chargedPayerAccountIds (list) –
  
  The list of payer accounts and their charge allocation percentages.
  - (dict) –
    
    An account that is charged all or a portion of the total Support charge and the percentage of the charge allocated to it.
    - accountId (string) –
      
      The account ID.
    - chargePercentage (string) –
      
      The percentage of the total Support charge allocated to this account. This is 0.0 when supportAllocationMethod = Proportional.
- additionalSupportCharge (list) –
  
  Any Additional support charges applied to the contract.
  - (dict) –
    
    An additional charge applied to an Enterprise Support contract.
    - description (string) –
      
      A description of the additional charge.
    - amount (string) –
      
      The charge amount.
    - chargeType (string) –
      
      The type of additional charge.
- additionalSupportEligibleUsageSpend (list) –
  
  Any Additional support-eligible usage spend charges.
  - (dict) –
    
    An additional charge applied to an Enterprise Support contract.
    - description (string) –
      
      A description of the additional charge.
    - amount (string) –
      
      The charge amount.
    - chargeType (string) –
      
      The type of additional charge.
- pricingPlans (list) –
  
  The pricing plans associated with this Enterprise Support contract.
  - (dict) –
    
    A pricing plan for Enterprise Support billing.
    - pricingPlanId (string) –
      
      The unique identifier for the pricing plan.
    - name (string) –
      
      The name of the pricing plan.
    - description (string) –
      
      A description of the pricing plan.
    - startDate (datetime) –
      
      The start date of the pricing plan.
    - endDate (datetime) –
      
      The end date of the pricing plan.
    - planDiscountPercent (string) –
      
      The discount percentage applied by this pricing plan.
    - discountAppliesToMinimumCharge (boolean) –
      
      Whether the discount applies to the minimum Support charge.
    - minimumCharge (string) –
      
      The minimum Support charge amount for this pricing plan.
    - tiered (string) –
      
      Whether the pricing plan uses tiered pricing.
    - tiers (list) –
      
      The pricing tiers within this plan.
      - (dict) –
        
        A tier within an Enterprise Support pricing plan.
        
        tierMinimum (string) –
        
        The minimum spend threshold for this tier.
        
        tierMaximum (string) –
        
        The maximum spend threshold for this tier.
        
        baseCharge (string) –
        
        The base charge for this tier.
        
        additionalPercentageOfAggregateCharges (string) –
        
        The additional percentage applied to aggregate charges in this tier.
        
        aggregateChargesAdjustment (string) –
        
        The adjustment applied to aggregate charges.
        
        incremental (boolean) –
        
        Whether the tier charges are calculated incrementally.
        
        increment (string) –
        
        The increment amount for incremental tier calculations.
        
        incrementCharge (string) –
        
        The charge per increment.

Exceptions

Billing.Client.exceptions.ThrottlingException
Billing.Client.exceptions.ResourceNotFoundException
Billing.Client.exceptions.AccessDeniedException
Billing.Client.exceptions.ValidationException
Billing.Client.exceptions.InternalServerException