Model Reference

This page is a reference to all the models in the Python SDK. It exists on a seperate page to not clutter the main API reference.

Balance

class autumn.models.balance.Balance(**data)

balance: int

feature_id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

required_balance: Optional[int]

Customer models

class autumn.models.customers.ProductStatus(*values)

ACTIVE = 'active'

EXPIRED = 'expired'

SCHEDULED = 'scheduled'

TRIALING = 'trialing'

class autumn.models.customers.FeatureType(*values)

BOOLEAN = 'boolean'

CONTINUOUS_USE = 'continuous_use'

SINGLE_USE = 'single_use'

STATIC = 'static'

class autumn.models.customers.CustomerInvoice(**data)

created_at: int

currency: str

hosted_invoice_url: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product_ids: List[str]

status: str

stripe_id: str

total: float

class autumn.models.customers.CustomerFeature(**data)

balance: Optional[float]

breakdown: Optional[List[Dict[str, Any]]]

id: str

included_usage: Optional[float]

interval: Optional[ProductItemInterval]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

next_reset_at: Optional[int]

type: Optional[FeatureType]

unlimited: Optional[bool]

usage: Optional[float]

class autumn.models.customers.CustomerProduct(**data)

canceled_at: Optional[int]

current_period_end: Optional[int]

current_period_start: Optional[int]

group: Optional[str]

id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

quantity: Optional[int]

started_at: int

status: ProductStatus

subscription_ids: Optional[List[str]]

class autumn.models.customers.Customer(**data)

created_at: int

email: Optional[str]

env: AppEnv

features: Dict[str, CustomerFeature]

fingerprint: Optional[str]

id: Optional[str]

invoices: Optional[List[CustomerInvoice]]

metadata: Dict[str, Any]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

payment_method: Optional[Any]

products: List[CustomerProduct]

referrals: Optional[List[CustomerReferral]]

stripe_id: Optional[str]

class autumn.models.customers.PriceInfo(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

primaryText: str

secondaryText: Optional[str]

class autumn.models.customers.ItemInfo(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

primaryText: str

secondaryText: Optional[str]

class autumn.models.customers.ProductStatus(*values)

ACTIVE = 'active'

EXPIRED = 'expired'

SCHEDULED = 'scheduled'

TRIALING = 'trialing'

class autumn.models.customers.GetPricingTableParams(**data)

customer_id: Optional[str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.customers.PricingTableProduct(**data)

buttonText: str

id: str

items: List[ItemInfo]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

price: PriceInfo

Feature models

class autumn.models.features.Feature(**data)

feature_id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quantity: int

class autumn.models.features.FeaturePreview(**data)

feature_id: str

feature_name: str

message: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

products: List[Product]

scenario: Literal['usage_limit', 'feature_flag']

title: str

upgrade_product_id: str

Product models

class autumn.models.products.FreeTrialDuration(*values)

DAY = 'day'

class autumn.models.products.UsageModel(*values)

PAY_PER_USE = 'pay_per_use'

PREPAID = 'prepaid'

class autumn.models.products.ProductItemInterval(*values)

DAY = 'day'

HOUR = 'hour'

LIFETIME = 'lifetime'

MINUTE = 'minute'

MONTH = 'month'

MULTIPLE = 'multiple'

QUARTER = 'quarter'

SEMI_ANNUAL = 'semi_annual'

WEEK = 'week'

YEAR = 'year'

class autumn.models.products.PriceCurrencyPair(**data)

currency: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

price: float

class autumn.models.products.PriceTier(**data)

amount: Union[float, str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to: float

class autumn.models.products.ProductItem(**data)

billing_units: Optional[float]

entity_feature_id: Optional[str]

feature_id: Optional[str]

included_usage: Union[float, str, None]

interval: Optional[ProductItemInterval]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

price: Optional[float]

reset_usage_on_billing: Optional[bool]

reset_usage_when_enabled: Optional[bool]

usage_model: Optional[UsageModel]

class autumn.models.products.FreeTrialDuration(*values)

DAY = 'day'

class autumn.models.products.FreeTrial(**data)

duration: FreeTrialDuration

length: float

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

unique_fingerprint: bool

class autumn.models.products.ProductScenario(*values)

ACTIVE = 'active'

CANCEL = 'cancel'

DOWNGRADE = 'downgrade'

NEW = 'new'

RENEW = 'renew'

SCHEDULED = 'scheduled'

UPGRADE = 'upgrade'

class autumn.models.products.Product(**data)

base_variant_id: Optional[str]

created_at: float

env: AppEnv

free_trial: Optional[FreeTrial]

group: Optional[str]

id: str

is_add_on: bool

is_default: bool

items: List[ProductItem]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

scenario: Optional[ProductScenario]

version: float

class autumn.models.products.ProductPreview(**data)

current_product_name: str

due_next_cycle: PriceCurrencyPair

due_today: PriceCurrencyPair

items: List[ProductItem]

message: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_cycle_at: int

options: List[str]

product_id: str

product_name: str

recurring: bool

scenario: ProductScenario

title: str

Entity models

class autumn.models.entities.Entity(**data)

created_at: int

customer_id: str

env: AppEnv

features: Dict[str, CustomerFeature]

id: str

invoices: Optional[List[CustomerInvoice]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

products: List[CustomerProduct]

Environment

class autumn.models.env.AppEnv(*values)

LIVE = 'live'

PRODUCTION = 'production'

SANDBOX = 'sandbox'

Response models

class autumn.models.response.AttachResponse(**data)

checkout_url: Optional[str]

code: str

customer_id: str

message: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product_ids: List[str]

success: Optional[bool]

class autumn.models.response.CheckResponse(**data)

allowed: bool

balance: Optional[float]

code: str

customer_id: str

feature_id: Optional[str]

feature_preview: Optional[FeaturePreview]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product_id: Optional[str]

product_preview: Optional[ProductPreview]

status: Optional[str]

class autumn.models.response.TrackResponse(**data)

code: str

customer_id: str

event_name: Optional[str]

feature_id: Optional[str]

id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.response.UsageResponse(**data)

code: str

customer_id: str

feature_id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.response.CreateProductResponse(**data)

created_at: int

env: AppEnv

free_trial: Optional[FreeTrial]

id: str

is_add_on: bool

is_default: bool

items: List[ProductItem]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

version: int

autumn.models.response.GetProductResponse

alias of CreateProductResponse

class autumn.models.response.ReferralCodeResponse(**data)

code: str

created_at: int

customer_id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.response.CancelResponse(**data)

customer_id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product_id: str

success: bool

class autumn.models.response.PricingTableResponse(**data)

list: List[PricingTableProduct]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.response.CheckoutLine(**data)

amount: float

description: str

item: ProductItem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.response.CheckoutNextCycle(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

starts_at: int

total: float

class autumn.models.response.CheckoutResponse(**data)

currency: str

current_product: Optional[Product]

customer_id: str

has_prorations: bool

lines: List[CheckoutLine]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_cycle: Optional[CheckoutNextCycle]

options: List[FeatureOptions]

product: Optional[Product]

total: float

url: Optional[str]

class autumn.models.response.ListProductResponse(**data)

list: List[Product]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.response.ListCustomerResponse(**data)

limit: int

list: List[Customer]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: int

total: int

class autumn.models.response.QueryResponse(**data)

list: List[QueryDP]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.response.TransferProductResponse(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

success: bool

Meta models

class autumn.models.meta.Empty(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.meta.FeatureOptions(**data)

feature_id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quantity: int

class autumn.models.meta.ProductOptions(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product_id: str

quantity: Optional[int]

class autumn.models.meta.CustomerData(**data)

email: Optional[str]

fingerprint: Optional[str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

class autumn.models.meta.AttachProductOptions(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product_id: str

quantity: Optional[int]

class autumn.models.meta.CheckoutLine(**data)

amount: int

description: str

item: ProductItem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autumn.models.meta.Cycle(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

starts_at: int

total: float

class autumn.models.meta.QueryDP(**data)

get_usage(key)

Return type:

Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

period: int