# This file was auto-generated by Fern from our API Definition.

import typing

import pydantic
from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from ...types.billing_price_usage_type import BillingPriceUsageType
from ...types.billing_provider_type import BillingProviderType
from ...types.billing_tiers_mode import BillingTiersMode


class ListBillingProductPricesParams(UniversalBaseModel):
    """
    Input parameters
    """

    for_initial_plan: typing.Optional[bool] = pydantic.Field(default=None)
    """
    Filter for prices valid for initial plans (free prices only)
    """

    for_trial_expiry_plan: typing.Optional[bool] = pydantic.Field(default=None)
    """
    Filter for prices valid for trial expiry plans (free prices only)
    """

    ids: typing.Optional[typing.List[str]] = None
    interval: typing.Optional[str] = None
    is_active: typing.Optional[bool] = pydantic.Field(default=None)
    """
    Filter for active prices on active products (defaults to true if not specified)
    """

    limit: typing.Optional[int] = pydantic.Field(default=None)
    """
    Page limit (default 100)
    """

    offset: typing.Optional[int] = pydantic.Field(default=None)
    """
    Page offset (default 0)
    """

    price: typing.Optional[int] = None
    product_id: typing.Optional[str] = None
    product_ids: typing.Optional[typing.List[str]] = None
    provider_type: typing.Optional[BillingProviderType] = None
    q: typing.Optional[str] = None
    tiers_mode: typing.Optional[BillingTiersMode] = None
    usage_type: typing.Optional[BillingPriceUsageType] = None
    with_meter: typing.Optional[bool] = pydantic.Field(default=None)
    """
    Filter for prices with a meter
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
