subscription

type AccountStatus struct {
	Status       string
	Tier         string
	Seats        int64      // effective seat count. Zero means no seat-based subscription.
	Interval     string     // tier billing cadence: "monthly" | "yearly" | ""
	ActiveAddOns []string   // purchased add-on tokens; entitlements cover manual grants separately
	Trial        *TrialInfo // set only when in an active trial
	Entitlements []string
	OnDemand     *OnDemandState // best-effort; nil if unavailable
	Endpoints    *EndpointUsage // best-effort; nil when the server omits it
}

type AddOnAttacher interface {
	// AttachAddOn purchases the add-on on the tenant's subscription and returns
	// the account's active add-on tokens after the change.
	AttachAddOn(ctx context.Context, addOn string, terms string) ([]string, error)
}

type AddOnDetacher interface {
	// DetachAddOn removes the add-on and returns the remaining active add-on
	// tokens.
	DetachAddOn(ctx context.Context, addOn string) ([]string, error)
}

type AssetClassUsage struct {
	DisplayName   string
	ActiveAssets  int64
	AssetsPerUnit int64
	Units         int64
}

type Catalog struct {
	Products []CatalogProduct
}

type CatalogGetter interface {
	// Catalog returns the price catalog: list prices for sellable products.
	Catalog(ctx context.Context) (*Catalog, error)
}

type CatalogPrice struct {
	UnitAmountMinor int64
	Currency        string
	Interval        string // "monthly" | "yearly" | ""
	Metered         bool
}

type CatalogProduct struct {
	DisplayName string
	Kind        string // "subscription_tier" | "add_on" | "overage"
	AddOn       string // add-on token when Kind is "add_on", else ""
	PricingUnit string // selling unit ("seat", "scan"), empty for a flat product
	Prices      []CatalogPrice
}

type CheckoutInput struct {
	Seats      uint32
	AddOns     []string // add-on tokens to buy alongside the seats
	SuccessURL string
	CancelURL  string
}

type CheckoutResult struct {
	Outcome      string // checkoutSuccess | checkoutNeeded | checkoutError
	URL          string
	ErrorCode    string
	ErrorMessage string
}

type Customer struct {
	ID      string
	Name    string
	Email   string
	Phone   string
	Country string
	State   string
	City    string
	Postal  string
	Line1   string
	Line2   string
	TaxID   string
}

type CustomerCreator interface {
	CreateCustomer(ctx context.Context, in CustomerInput) (*Customer, []ProviderError, error)
}

type CustomerGetter interface {
	// GetCustomer returns the billing customer and whether one exists. A
	// missing customer is (nil, false, nil), not an error.
	GetCustomer(ctx context.Context) (*Customer, bool, error)
}

type CustomerInput struct {
	Name    string
	Phone   string
	Country string
	State   string
	City    string
	Postal  string
	Line1   string
	Line2   string
	TaxID   string
}

type EndpointUsage struct {
	UnitsUsed     int64
	UnitsIncluded int64 // meaningful only when HasIncluded
	HasIncluded   bool  // false when the account has no defined allotment
	Breakdown     []AssetClassUsage
	PeriodEnd     time.Time // reset instant; zero when the server omits it
}

type FeatureOverage struct {
	CapKind        string // "units" | "monetary"
	CapUnits       int64
	UnitPriceMinor int64
	CapAmountMinor int64
	Currency       string
}

type FeatureUsage struct {
	FeatureKey        string
	DisplayName       string
	UnitLabel         string
	IncludedLimit     int64 // -1 unlimited, 0 not-available, >0 finite
	Consumed          int64
	Seats             int64
	Tier              string
	PeriodEnd         time.Time
	Provisional       bool // enforcement == PROVISIONAL
	Overage           *FeatureOverage
	OverageUsed       int64
	OverageUsedMinor  int64
	SettlementPending bool // settlement_status == PENDING
}

type OnDemandDisabler interface {
	DisableOnDemand(ctx context.Context) (*OnDemandState, error)
}

type OnDemandEnabler interface {
	EnableOnDemand(ctx context.Context, terms string) (*OnDemandState, error)
}

type OnDemandState struct {
	Enabled             bool
	PaymentMethodOnFile bool
	Posture             string
	Usage               []FeatureUsage
}

type OnDemandStateGetter interface {
	OnDemandState(ctx context.Context) (*OnDemandState, error)
}

type PortalOpener interface {
	Portal(ctx context.Context, returnURL string) (string, error)
}

type ProviderError struct {
	Type    string
	Param   string
	Message string
}

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

type StatusGetter interface {
	Status(ctx context.Context) (*AccountStatus, error)
}

type Subscriber interface {
	Checkout(ctx context.Context, in CheckoutInput) (*CheckoutResult, error)
}

type TrialActivator interface {
	ActivateTrial(ctx context.Context) error
}

type TrialInfo struct {
	DaysRemaining int32
	ExpiresAt     time.Time
}