Options
All
  • Public
  • Public/Protected
  • All
Menu

Module monetization

Index

Type aliases

EntitledState

EntitledState: "ENTITLED" | "NOT_ENTITLED"

State determining if the user is entitled to the product. Note - Any new values introduced later should be treated as 'NOT_ENTITLED'. * 'ENTITLED' - The user is entitled to the product. * 'NOT_ENTITLED' - The user is not entitled to the product.

enum

EntitlementReason

EntitlementReason: "PURCHASED" | "NOT_PURCHASED" | "AUTO_ENTITLED"

Reason for the entitlement status. * 'PURCHASED' - The user is entitled to the product because they purchased it. * 'NOT_PURCHASED' - The user is not entitled to the product because they have not purchased it. * 'AUTO_ENTITLED' - The user is auto entitled to the product because they have subscribed to a broader service.

enum

ProductType

ProductType: "SUBSCRIPTION" | "ENTITLEMENT" | "CONSUMABLE"

Product type. * 'SUBSCRIPTION' - Once purchased, customers will own the content for the subscription period. * 'ENTITLEMENT' - Once purchased, customers will own the content forever. * 'CONSUMABLE' - Once purchased, customers will be entitled to the content until it is consumed. It can also be re-purchased.

enum

PurchasableState

PurchasableState: "PURCHASABLE" | "NOT_PURCHASABLE"

State determining if the product is purchasable by the user. Note - Any new values introduced later should be treated as 'NOT_PURCHASABLE'. * 'PURCHASABLE' - The product is purchasable by the user. * 'NOT_PURCHASABLE' - The product is not purchasable by the user.

enum

PurchaseMode

PurchaseMode: "TEST" | "LIVE"

Indicates if the entitlements are for TEST or LIVE purchases. * 'TEST' - test purchases made by developers or beta testers. Purchase not sent to payment processing. * 'LIVE' - purchases made by live customers. Purchase sent to payment processing.

enum

Status

Status: "PENDING_APPROVAL_BY_PARENT" | "APPROVED_BY_PARENT" | "DENIED_BY_PARENT" | "EXPIRED_NO_ACTION_BY_PARENT" | "ERROR"

Transaction status for in skill product purchases. * 'PENDING_APPROVAL_BY_PARENT' - The transaction is pending approval from parent. * 'APPROVED_BY_PARENT' - The transaction was approved by parent and fulfilled successfully.. * 'DENIED_BY_PARENT' - The transaction was declined by parent and hence not fulfilled. * 'EXPIRED_NO_ACTION_BY_PARENT' - The transaction was expired due to no response from parent and hence not fulfilled. * 'ERROR' - The transaction was not fullfiled as there was an error while processing the transaction.

enum