entitlements

type AttachFeatureToProductWithOptions func(params *stripe.ProductFeatureCreateParams)

type BillingPortalSession struct {
	ManageSubscription string `json:"manage_subscription"`
	PaymentMethods     string `json:"payment_methods"`
	Cancellation       string `json:"cancellation"`
	HomePage           string `json:"home_page"`
}

type Config struct {
	// Enabled determines if the entitlements service is enabled
	Enabled bool `json:"enabled" koanf:"enabled" default:"false"`
	// PrivateStripeKey is the key for the stripe service
	PrivateStripeKey string `json:"privateStripeKey" koanf:"privateStripeKey" default:"" sensitive:"true"`
	// StripeWebhookSecret is the secret for the stripe service (legacy, use StripeWebhookSecrets for version-specific secrets)
	StripeWebhookSecret string `json:"stripeWebhookSecret" koanf:"stripeWebhookSecret" default:"" sensitive:"true"`
	// StripeWebhookSecrets is a map of API version to webhook secrets for safe migration rollback
	StripeWebhookSecrets map[string]string `json:"stripeWebhookSecrets" koanf:"stripeWebhookSecrets" sensitive:"true"`
	// StripeWebhookURL is the URL for the stripe webhook
	StripeWebhookURL string `` /* 178-byte string literal not displayed */
	// StripeBillingPortalSuccessURL
	StripeBillingPortalSuccessURL string `` /* 239-byte string literal not displayed */
	// StripeCancellationReturnURL is the URL for the stripe cancellation return
	StripeCancellationReturnURL string `` /* 235-byte string literal not displayed */
	// StripeWebhookEvents is the list of events to register when creating a webhook endpoint
	StripeWebhookEvents []string `json:"stripeWebhookEvents" koanf:"stripeWebhookEvents"`
	// StripeWebhookAPIVersion is the Stripe API version currently accepted by the webhook handler
	StripeWebhookAPIVersion string `json:"stripeWebhookAPIVersion" koanf:"stripeWebhookAPIVersion" default:"2025_10_29_CLOVER"`
	// StripeWebhookDiscardAPIVersion is the Stripe API version to discard during migration
	StripeWebhookDiscardAPIVersion string `json:"stripeWebhookDiscardAPIVersion" koanf:"stripeWebhookDiscardAPIVersion" default:""`
}

type ConfigOpts func(*Config)

type ContactInfo struct {
	Email      string  `json:"email"`
	Phone      string  `json:"phone"`
	City       *string `form:"city"`
	Country    *string `form:"country"`
	Line1      *string `form:"line1"`
	Line2      *string `form:"line2"`
	PostalCode *string `form:"postal_code"`
	State      *string `form:"state"`
}

type CustomerCreateOption func(params *stripe.CustomerCreateParams)

type CustomerUpdateOption func(params *stripe.CustomerUpdateParams)

type FGAClient interface {
	CheckTuple(ctx context.Context, tuple FeatureTuple) (bool, error)
	CreateTuple(ctx context.Context, tuple FeatureTuple) error
	DeleteTuple(ctx context.Context, tuple FeatureTuple) error
}

type Feature struct {
	ID        string `json:"id" yaml:"id"`
	Name      string `json:"name" yaml:"name"`
	Lookupkey string `json:"lookupkey" yaml:"lookupkey"`
}

type FeatureCreateOption func(params *stripe.EntitlementsFeatureCreateParams)

type FeatureTuple struct {
	// UserID is the identifier for the user or entity being checked
	UserID string
	// Feature is the name of the feature being checked - can be any feature
	Feature string
	// Context is a map of additional context for the tuple, can be used for feature flags or other metadata
	Context map[string]any
}

type FeatureUpdateOption func(params *stripe.EntitlementsFeatureUpdateParams)

type MigrationStage string

type OrganizationCustomer struct {
	OrganizationID               string `json:"organization_id"`
	OrganizationSettingsID       string `json:"organization_settings_id"`
	StripeCustomerID             string `json:"stripe_customer_id"`
	OrganizationName             string `json:"organization_name"`
	OrganizationSubscriptionID   string `json:"organization_subscription_id"`
	StripeSubscriptionID         string `json:"stripe_subscription_id"`
	StripeSubscriptionScheduleID string `json:"stripe_subscription_schedule_id"`
	PaymentMethodAdded           bool   `json:"payment_method_added"`
	Features                     []string
	FeatureNames                 []string
	Metadata                     map[string]string `json:"metadata"`

	Subscription
	ContactInfo
}

type Price struct {
	ID          string  `json:"price_id" yaml:"price_id"`
	Price       float64 `json:"price" yaml:"price"`
	Currency    string  `json:"currency" yaml:"currency"`
	ProductID   string  `json:"product_id" yaml:"-"`
	ProductName string  `json:"product_name" yaml:"product_name"`
	Interval    string  `json:"interval" yaml:"interval"`
}

type PriceCreateOption func(params *stripe.PriceCreateParams)

type PriceUpdateOption func(params *stripe.PriceUpdateParams)

type Product struct {
	ID          string    `json:"product_id" yaml:"product_id"`
	Name        string    `json:"name" yaml:"name"`
	Description string    `json:"description,omitempty" yaml:"description,omitempty"`
	Features    []Feature `json:"features" yaml:"features"`
	Prices      []Price   `json:"prices" yaml:"prices"`
}

type ProductFeature struct {
	FeatureID string `json:"feature_id" yaml:"feature_id"`
	ProductID string `json:"product_id"`
	Name      string `json:"name" yaml:"name"`
	Lookupkey string `json:"lookupkey" yaml:"lookupkey"`
}

type ProductFeatureCreateOption func(params *stripe.ProductFeatureCreateParams)

type ProductUpdateOption func(params *stripe.ProductUpdateParams)

type StripeClient struct {
	// Client is the Stripe client and is used for accessing all subsequent stripe objects, e.g. products, prices, etc.
	Client *stripe.Client

	// config is the configuration for the Stripe client
	Config *Config
	// contains filtered or unexported fields
}

type StripeOptions func(*StripeClient)

type Subscription struct {
	ID                           string `json:"plan_id" yaml:"plan_id"`
	ProductID                    string `json:"product_id" yaml:"product_id"`
	PriceID                      string `json:"price_id" yaml:"price_id"`
	StartDate                    int64  `json:"start_date" yaml:"start_date"`
	EndDate                      int64  `json:"end_date" yaml:"end_date"`
	Features                     []Feature
	Prices                       []Price
	TrialEnd                     int64
	Status                       string
	StripeCustomerID             string
	OrganizationID               string
	StripeSubscriptionScheduleID string
	DaysUntilDue                 int64
	Metadata                     map[string]string
}

type SubscriptionCreateOption func(params *stripe.SubscriptionCreateParams)

type SubscriptionUpdateOption func(params *stripe.SubscriptionUpdateParams)

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

type TupleCheckerOption func(*TupleChecker)

type WebhookMigrationOption func(*webhookMigrationOptions)

type WebhookMigrationState struct {
	OldWebhook        *stripe.WebhookEndpoint
	NewWebhook        *stripe.WebhookEndpoint
	CurrentSDKVersion string
	CanMigrate        bool
	MigrationStage    string
}