:doc:`BillingConductor <../../billingconductor>` / Client / list_pricing_plans

******************
list_pricing_plans
******************



.. py:method:: BillingConductor.Client.list_pricing_plans(**kwargs)

  

  A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/billingconductor-2021-07-30/ListPricingPlans>`_  


  **Request Syntax**
  ::

    response = client.list_pricing_plans(
        BillingPeriod='string',
        Filters={
            'Arns': [
                'string',
            ]
        },
        MaxResults=123,
        NextToken='string'
    )
    
  :type BillingPeriod: string
  :param BillingPeriod: 

    The preferred billing period to get pricing plan.

    

  
  :type Filters: dict
  :param Filters: 

    A ``ListPricingPlansFilter`` that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information.

    

  
    - **Arns** *(list) --* 

      A list of pricing plan Amazon Resource Names (ARNs) to retrieve information.

      

    
      - *(string) --* 

      
  
  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of pricing plans to retrieve.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token that's used on subsequent call to get pricing plans.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'BillingPeriod': 'string',
          'PricingPlans': [
              {
                  'Name': 'string',
                  'Arn': 'string',
                  'Description': 'string',
                  'Size': 123,
                  'CreationTime': 123,
                  'LastModifiedTime': 123
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **BillingPeriod** *(string) --* 

        The billing period for which the described pricing plans are applicable.

        
      

      - **PricingPlans** *(list) --* 

        A list of ``PricingPlanListElement`` retrieved.

        
        

        - *(dict) --* 

          A representation of a pricing plan.

          
          

          - **Name** *(string) --* 

            The name of a pricing plan.

            
          

          - **Arn** *(string) --* 

            The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan.

            
          

          - **Description** *(string) --* 

            The pricing plan description.

            
          

          - **Size** *(integer) --* 

            The pricing rules count that's currently associated with this pricing plan list element.

            
          

          - **CreationTime** *(integer) --* 

            The time when the pricing plan was created.

            
          

          - **LastModifiedTime** *(integer) --* 

            The most recent time when the pricing plan was modified.

            
      
    
      

      - **NextToken** *(string) --* 

        The pagination token that's used on subsequent calls to get pricing plans.

        
  
  **Exceptions**
  
  *   :py:class:`BillingConductor.Client.exceptions.ThrottlingException`

  
  *   :py:class:`BillingConductor.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`BillingConductor.Client.exceptions.ValidationException`

  
  *   :py:class:`BillingConductor.Client.exceptions.InternalServerException`

  