Files
cfw-autumn/others/python-sdk/docs/models/preview.md
2026-02-19 16:05:43 +00:00

4.9 KiB

Preview

Upgrade/upsell information when access is denied. Only present if with_preview was true and allowed is false.

Fields

Field Type Required Description
scenario models.Scenario ✔️ The reason access was denied. 'usage_limit' means the customer exceeded their balance, 'feature_flag' means the feature is not included in their plan.
title str ✔️ A title suitable for displaying in a paywall or upgrade modal.
message str ✔️ A message explaining why access was denied.
feature_id str ✔️ The ID of the feature that was checked.
feature_name str ✔️ The display name of the feature.
products List[models.Product] ✔️ Products that would grant access to this feature. Use to display upgrade options.