control

type Account struct {
	ProviderID string `json:"id"`
	Email      string `json:"email"`
	CreatedAt  int64  `json:"created"`
	KeySource  string `json:"key_source"`
	Isolated   bool   `json:"isolated"`
}

type CheckoutParams struct {
	TrialDays             int
	Features              []Feature
	CancelURL             string
	RequireBillingAddress bool
	AutomaticTax          bool
	CollectTaxID          bool
}

type Client struct {
	Logf      func(format string, args ...any)
	Stripe    *stripe.Client
	KeySource string // the source of the API key
	// contains filtered or unexported fields
}

type Clock struct {
	// contains filtered or unexported fields
}

type Coupon struct {
	ID               string `json:"id"`
	Metadata         map[string]string
	Created          time.Time
	AmountOff        int     `json:"amount_off"`
	Currency         string  `json:"currency"`
	Duration         string  `json:"duration"`
	DurationInMonths int     `json:"duration_in_months"`
	MaxRedemptions   int     `json:"max_redemptions"`
	Name             string  `json:"name"`
	PercentOff       float64 `json:"percent_off"`
	RedeemBy         time.Time
	TimesRedeemed    int  `json:"times_redeemed"`
	Valid            bool `json:"valid"`
}

type Feature struct {
	refs.FeaturePlan // the feature name prefixed with ("feature:")

	ProviderID string // identifier set by the billing engine provider
	PlanTitle  string // a human readable title for the plan
	Title      string // a human readable title for the feature

	// Interval specifies the billing interval for the feature.
	//
	// Known intervals are "@daily", "@weekly", "@monthly", and "@yearly".
	Interval string

	// Currency is the ISO 4217 currency code for the feature.
	//
	// Known currencies look like "usd", "eur", "gbp", "cad", "aud", "jpy", "chf",
	// etc. Please see your billing engine provider for a complete list.
	Currency string

	// Base is the base price for the feature. If Tiers is not empty, then Base
	// is ignored.
	Base float64

	// Mode specifies the billing mode for use with Tiers.
	//
	// Known modes are "graduated" and "volume".
	Mode string

	// Aggregate specifies the usage aggregation method for use with Tiers.
	//
	// Known aggregates are "sum", "max", "last", and "perpetual".
	Aggregate string

	// Tiers optionally specifies the pricing tiers for this feature. If
	// empty, feature is billed at the beginning of each billing period at
	// the flat rate specified by Base. If non-empty, the feature is billed
	// at the end of each billing period based on usage, and at a price
	// determined by Tiers, Mode, and Aggregate.
	Tiers []Tier

	// ReportID is the ID for reporting usage to the billing provider.
	ReportID string

	TransformDenominator int  // the denominator for transforming usage
	TransformRoundUp     bool // whether to round up transformed usage; otherwise round down
}

type Invoice struct {
	Amount float64
	Period Period
	Lines  []InvoiceLineItem

	SubtotalPreTax int
	Subtotal       int
	TotalPreTax    int
	Total          int
}

type InvoiceLineItem struct {
	Period    Period
	Feature   refs.FeaturePlan
	Quantity  int
	Amount    float64
	Proration bool
}

type InvoiceSettings struct {
	DefaultPaymentMethod string `json:"default_payment_method"`
}

type Org struct {
	ProviderID string
	ID         string
	Email      string
}

type OrgInfo struct {
	Email       string
	Name        string
	Description string
	Phone       string
	Metadata    map[string]string
	Created     int

	PaymentMethod   string
	InvoiceSettings InvoiceSettings `json:"invoice_settings"`
}

type Period struct {
	Effective time.Time
	End       time.Time
}

type Phase struct {
	Org       string // set on read
	Effective time.Time
	Features  []refs.FeaturePlan
	Current   bool

	Trial bool // Marks the phase as a trial phase. No fees will be incurred during a trial phase.

	// Plans is the set of plans that are currently active for the phase. A
	// plan is considered active in a phase if all of its features are
	// listed in the phase. If any features from a plan is in the phase
	// without the other features in the plan, this phase is considered
	// "fragmented".
	Plans []refs.Plan

	AutomaticTax bool

	Coupon string // deprecated

	// CouponData is the coupon that was applied to the subscription. It is
	// nil if no coupon was applied.
	CouponData *Coupon
}

type PushReportFunc func(Feature, error)

type Report struct {
	N       int
	At      time.Time
	Clobber bool
}

type Schedule struct {
	Current Period
	Phases  []Phase
}

type ScheduleParams struct {
	PaymentMethod string
	Phases        []Phase
}

type Tier struct {
	Upto  int     // the upper limit of the tier
	Price float64 // the price of the tier
	Base  int     // the base price of the tier
}

type Usage struct {
	Feature refs.FeaturePlan
	Start   time.Time
	End     time.Time
	Used    int
	Limit   int
}

type ValidationError struct {
	Message string
}