Commerce.PurchaseState
EnumRepresents the state of a purchase in a Lens.
- Snapchat: not supported
- SPECS: fully supported
- Camera Kit Web: not supported
- Camera Kit Mobile: not supported
- SnapchatNot supported — Available on SPECS only
- SPECSFully supported
- Camera Kit WebNot supported — Available on SPECS only
- Camera Kit MobileNot supported — Available on SPECS only
Represents the state of a purchase in a Lens.
Index
Enumeration Members
Enumeration Members
Expired
Expired:
number
SPECS
The subscription's billing period has ended without renewal — either the user canceled and the paid period ran out, or a renewal payment failed. The user should no longer have access to the subscription content. Applies to ProductType.Subscription purchases only.
Since
Lens Scripting Version 377
Invalidated
Invalidated:
number
SPECS
The purchase has been invalidated, meaning it is no longer considered active or valid. This can happen for several reasons, such as a refund being issued for the purchase, or other system-level invalidations. When a purchase is invalidated, the user should no longer have access to the associated product or feature.
Pending
Pending:
number
SPECS
The purchase is currently in a state of waiting for further action or confirmation. This might occur if the
transaction requires additional verification, if there's a delay in payment processing, or for certain types of
payment methods. The purchase is not yet finalized, and the user may not have access to the item until its state
changes to Purchased. You should monitor for updates to this purchase through the
ClientOptions.onPurchasesUpdated.
Purchased
Purchased:
number
SPECS
The product has been successfully bought and the transaction is complete. At this state, the user should have access to the purchased item or feature.
Unset
Unset:
number
SPECS
The product is not currently in the user's purchase history, meaning it has not been purchased or is no longer considered owned. For items that should be owned, this typically means the user has not yet acquired it.