atmn 1.1.25 → 2.0.0

package/src/generated/licenses.ts

@@ -0,0 +1,287 @@
+// Generated by @autumn/atmn-generator from packages/openapi/openapi-internal.yml.
+// Do not edit — run `bun generate` in packages/atmn-generator instead.
+
+export type License = {
+	licensePlanId: string;
+	versionSlug?: string;
+	included?: number;
+	prepaidOnly?: boolean;
+	customize?: {
+		price?: {
+			/** Base price amount for the plan, in major currency units (e.g. dollars). */
+			amount: number;
+			/** Billing interval (e.g. 'month', 'year'). */
+			interval:
+				| "one_off"
+				| "week"
+				| "month"
+				| "quarter"
+				| "semi_annual"
+				| "year";
+			/** Number of intervals per billing cycle. Defaults to 1. */
+			intervalCount?: number;
+			/** Base price amounts in additional currencies. The base 'amount' is in the org's default currency. */
+			additionalCurrencies?: Array<{
+				/** Three-letter Stripe-supported currency code (e.g. 'eur', 'gbp'). */
+				currency: string;
+				/** Price amount in this currency. Set explicitly per currency, not converted from the base amount. */
+				amount: number;
+			}>;
+		} | null;
+		addItems?: Array<{
+			/** Bills this many feature units when outstanding overage reaches it. */
+			thresholdBilling?: {
+				threshold: number;
+			} | null;
+			/** The ID of the feature to configure. */
+			featureId: string;
+			/** Number of free units included. Balance resets to this each interval for consumable features. */
+			included?: number;
+			/** If true, customer has unlimited access to this feature. */
+			unlimited?: boolean;
+			/** Whether entity-level grants contribute to a shared customer balance. Defaults to false. */
+			pooled?: boolean;
+			/** Reset configuration for consumable features. Omit for non-consumable features like seats. */
+			reset?: {
+				/** Interval at which balance resets (e.g. 'month', 'year'). For consumable features only. */
+				interval:
+					| "one_off"
+					| "minute"
+					| "hour"
+					| "day"
+					| "week"
+					| "month"
+					| "quarter"
+					| "semi_annual"
+					| "year";
+				/** Number of intervals between resets. Defaults to 1. */
+				intervalCount?: number;
+			};
+			/** Pricing for usage beyond included units. Omit for free features. */
+			price?: {
+				/** Price per billing_units after included usage. Either 'amount' or 'tiers' is required. */
+				amount?: number;
+				/** Amounts in additional currencies for this flat price. The base 'amount' is in the org's default currency. Only valid with 'amount', not 'tiers'. */
+				additionalCurrencies?: Array<{
+					/** Three-letter Stripe-supported currency code (e.g. 'eur', 'gbp'). */
+					currency: string;
+					/** Price amount in this currency. Set explicitly per currency, not converted from the base amount. */
+					amount: number;
+				}>;
+				/** Tiered pricing. Either 'amount' or 'tiers' is required. */
+				tiers?: Array<{
+					to: number | "inf";
+					amount?: number;
+					flatAmount?: number;
+					/** Per-currency amounts for this tier. Tier boundaries ('to') are shared across all currencies. */
+					additionalCurrencies?: Array<{
+						/** Three-letter Stripe-supported currency code (e.g. 'eur', 'gbp'). */
+						currency: string;
+						/** Per-unit amount for this tier in this currency. */
+						amount?: number;
+						/** Flat amount for this tier in this currency, if the tier uses one. */
+						flatAmount?: number;
+					}>;
+				}>;
+				tierBehavior?: "graduated" | "volume";
+				/** Billing interval. For consumable features, should match reset.interval. */
+				interval:
+					| "one_off"
+					| "week"
+					| "month"
+					| "quarter"
+					| "semi_annual"
+					| "year";
+				/** Number of intervals per billing cycle. Defaults to 1. */
+				intervalCount?: number;
+				/** Units per price increment. Usage is rounded UP when billed (e.g. billing_units=100 means 101 rounds to 200). Defaults to 1. */
+				billingUnits?: number;
+				/** 'prepaid' for upfront payment (seats), 'usage_based' for pay-as-you-go. */
+				billingMethod: "prepaid" | "usage_based";
+				allocatedBilling?: "arrear" | "prorated_legacy";
+				/** Max units purchasable beyond included. E.g. included=100, max_purchase=300 allows 400 total. Null for no limit. */
+				maxPurchase?: number | null;
+			};
+			/** Proration settings for prepaid features. Controls mid-cycle quantity change billing. */
+			proration?: {
+				/** Billing behavior when quantity increases mid-cycle. */
+				onIncrease:
+					| "bill_immediately"
+					| "prorate_immediately"
+					| "prorate_next_cycle"
+					| "bill_next_cycle";
+				/** Credit behavior when quantity decreases mid-cycle. */
+				onDecrease:
+					| "prorate"
+					| "prorate_immediately"
+					| "prorate_next_cycle"
+					| "none"
+					| "no_prorations";
+			};
+			/** Rollover config for unused units. If set, unused included units carry over. */
+			rollover?: {
+				/** Max rollover units. Omit for unlimited rollover. */
+				max?: number;
+				/** Maximum rollover as a percentage (0-100) of included + prepaid grant. Mutually exclusive with max. */
+				maxPercentage?: number;
+				/** When rolled over units expire. */
+				expiryDurationType: "month" | "forever";
+				/** Number of periods before expiry. */
+				expiryDurationLength?: number;
+			};
+			/** Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema). */
+			featureOverride?: {
+				/** For credit system features: replaces the feature's credit_schema entirely for customers on this plan. */
+				creditSchema?: Array<
+					| {
+							/** ID of the metered feature that draws from this credit system. */
+							meteredFeatureId: string;
+							/** Number of metered-feature units priced together. Defaults to one when omitted. */
+							billingUnits?: number;
+							/** Named rates chosen by event properties. The most specific match sets the rate; with no match the item's own rate applies. */
+							dimensions?: Record<
+								string,
+								| {
+										/** Event properties this entry applies to. Every key must equal the tracked property, compared as strings. */
+										match: Record<string, string | number | boolean>;
+										/** Breaks ties between dimensions that match the same number of keys. Higher wins. */
+										priority?: number;
+										tierBehavior: "graduated";
+										tiers: Array<{
+											/** Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'. */
+											to: number | "inf";
+											/** Credits consumed per billing-unit group within this tier. */
+											creditCost: number;
+										}>;
+								  }
+								| {
+										/** Event properties this entry applies to. Every key must equal the tracked property, compared as strings. */
+										match: Record<string, string | number | boolean>;
+										/** Breaks ties between dimensions that match the same number of keys. Higher wins. */
+										priority?: number;
+										/** Credits consumed per billing-unit group when this dimension matches. */
+										creditCost: number;
+								  }
+							>;
+							/** Named adjustments chosen by event properties. Every match applies: factors multiply, then adds are summed. */
+							multipliers?: Record<
+								string,
+								{
+									/** Event properties this entry applies to. Every key must equal the tracked property, compared as strings. */
+									match: Record<string, string | number | boolean>;
+									/** Multiplies the matched rate. All matching multipliers stack. */
+									factor?: number;
+									/** Added to the rate after every factor is applied, in credits per billing-unit group. */
+									add?: number;
+								}
+							>;
+							tierBehavior: "graduated";
+							tiers: Array<{
+								/** Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'. */
+								to: number | "inf";
+								/** Credits consumed per billing-unit group within this tier. */
+								creditCost: number;
+							}>;
+					  }
+					| {
+							/** ID of the metered feature that draws from this credit system. */
+							meteredFeatureId: string;
+							/** Number of metered-feature units priced together. Defaults to one when omitted. */
+							billingUnits?: number;
+							/** Named rates chosen by event properties. The most specific match sets the rate; with no match the item's own rate applies. */
+							dimensions?: Record<
+								string,
+								| {
+										/** Event properties this entry applies to. Every key must equal the tracked property, compared as strings. */
+										match: Record<string, string | number | boolean>;
+										/** Breaks ties between dimensions that match the same number of keys. Higher wins. */
+										priority?: number;
+										tierBehavior: "graduated";
+										tiers: Array<{
+											/** Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'. */
+											to: number | "inf";
+											/** Credits consumed per billing-unit group within this tier. */
+											creditCost: number;
+										}>;
+								  }
+								| {
+										/** Event properties this entry applies to. Every key must equal the tracked property, compared as strings. */
+										match: Record<string, string | number | boolean>;
+										/** Breaks ties between dimensions that match the same number of keys. Higher wins. */
+										priority?: number;
+										/** Credits consumed per billing-unit group when this dimension matches. */
+										creditCost: number;
+								  }
+							>;
+							/** Named adjustments chosen by event properties. Every match applies: factors multiply, then adds are summed. */
+							multipliers?: Record<
+								string,
+								{
+									/** Event properties this entry applies to. Every key must equal the tracked property, compared as strings. */
+									match: Record<string, string | number | boolean>;
+									/** Multiplies the matched rate. All matching multipliers stack. */
+									factor?: number;
+									/** Added to the rate after every factor is applied, in credits per billing-unit group. */
+									add?: number;
+								}
+							>;
+							/** Credits consumed per billing-unit group. */
+							creditCost: number;
+					  }
+				>;
+				/** For AI credit system features: replaces the feature's markup chain entirely for customers on this plan. An unset level means no markup at that level rather than inheriting the feature's. */
+				markups?: {
+					/** Default percentage markup for customers on this plan. Use -100 to make usage free. */
+					defaultMarkup?: number;
+					/** Per-provider markup percentages for customers on this plan. */
+					providerMarkups?: Record<
+						string,
+						{
+							markup: number;
+						}
+					> | null;
+					/** Per-model markup overrides for customers on this plan. */
+					modelMarkups?: Record<
+						string,
+						{
+							markup?: number;
+							inputCost?: number;
+							outputCost?: number;
+						}
+					> | null;
+				};
+			};
+			entityFeatureId?: string;
+		}>;
+		removeItems?: Array<{
+			/** Match items linked to this feature. */
+			featureId?: string;
+			/** Match items with this billing method (prepaid or usage_based). */
+			billingMethod?: "prepaid" | "usage_based";
+			/** Match items with this interval. Accepts either a BillingInterval (price-side) or a ResetInterval (reset-side, includes day/hour/minute) so price-less items keyed by reset.interval can be disambiguated. */
+			interval?:
+				| "one_off"
+				| "week"
+				| "month"
+				| "quarter"
+				| "semi_annual"
+				| "year"
+				| "one_off"
+				| "minute"
+				| "hour"
+				| "day"
+				| "week"
+				| "month"
+				| "quarter"
+				| "semi_annual"
+				| "year";
+			/** Match items with this interval_count. Disambiguates between items that share an interval but differ in count. */
+			intervalCount?: number;
+			/** Match items whose grant equals this included usage. Omitted is a wildcard. */
+			included?: number;
+		}>;
+	} | null;
+	metadata?: Record<string, unknown>;
+};
+
+export const license = (input: License): License => input;