Skip to Content

EntitlementSchema

const EntitlementSchema: ZodObject<{ allowances: ZodArray<ZodObject<{ limit: ZodNumber; metric: ZodEnum<typeof UsageRuleAllowanceMetric>; remaining: ZodNumber; resetsAt: ZodNullable<ZodISODateTime>; rule: ZodUUID; scope: ZodObject<{ kind: ZodEnum<typeof UsageRuleScopeKind>; value: ZodString; }, $strip>; used: ZodNumber; }, $strip>>; grant: ZodUUID; object: ZodLiteral<"entitlement">; period: ZodObject<{ end: ZodNullable<ZodISODateTime>; start: ZodNullable<ZodISODateTime>; }, $strip>; product: ZodObject<{ billingInterval: ZodEnum<typeof BillingInterval>; displayName: ZodNullable<ZodString>; id: ZodUUID; isDefault: ZodBoolean; sku: ZodNullable<ZodString>; }, $strip>; rateLimits: ZodArray<ZodObject<{ limit: ZodNumber; metric: ZodEnum<typeof UsageRuleAllowanceMetric>; rule: ZodUUID; scope: ZodObject<{ kind: ZodEnum<typeof UsageRuleScopeKind>; value: ZodString; }, $strip>; window: ZodEnum<typeof RateLimitFrequency>; }, $strip>>; source: ZodEnum<{ appStore: "appStore"; default: "default"; manual: "manual"; stripe: "stripe"; }>; }, $strip>;

What an active product grant lets a customer do right now.

Last updated on