MonetizationAPI

export declare class MonetizationAPI
export declare class MonetizationAPI

No summary provided.

constructor(rest)
Constructs a new instance of the MonetizationAPI class
NameTypeOptionalDescription
restRESTNoNone
consumeEntitlement(applicationId, entitlementId, options?):Promise<void>
Marks a given entitlement for the user as consumed. Only available for One-Time Purchase consumable SKUs.
NameTypeOptionalDescription
applicationIdSnowflakeNoThe application id to consume the entitlement for
entitlementIdSnowflakeNoThe entitlement id to consume
optionsPick<RequestData, 'signal'>YesThe options for consuming the entitlement
createTestEntitlement(applicationId, body, options?):Promise<Partial<Omit<APIEntitlement, "ends_at" | "starts_at">>>
Creates a test entitlement for an application's SKU.
NameTypeOptionalDescription
applicationIdSnowflakeNoThe application id to create the entitlement for
bodyRESTPostAPIEntitlementJSONBodyNoThe data for creating the entitlement
optionsPick<RequestData, 'signal'>YesThe options for creating the entitlement
deleteTestEntitlement(applicationId, entitlementId, options?):Promise<void>
Deletes a test entitlement for an application's SKU.
NameTypeOptionalDescription
applicationIdSnowflakeNoThe application id to delete the entitlement for
entitlementIdSnowflakeNoThe entitlement id to delete
optionsPick<RequestData, 'signal'>YesThe options for deleting the entitlement
getEntitlements(applicationId, query, options?):Promise<RESTGetAPIEntitlementsResult>
Fetches the entitlements for an application.
NameTypeOptionalDescription
applicationIdSnowflakeNoThe application id to fetch entitlements for
queryRESTGetAPIEntitlementsQueryNoThe query options for fetching entitlements
optionsPick<RequestData, 'signal'>YesThe options for fetching entitlements
getSKUs(applicationId, options?):Promise<RESTGetAPISKUsResult>
Fetches the SKUs for an application.
NameTypeOptionalDescription
applicationIdSnowflakeNoThe application id to fetch SKUs for
optionsPick<RequestData, 'signal'>YesThe options for fetching the SKUs.
getSKUSubscription(skuId, subscriptionId, options?):Promise<APISubscription>
NameTypeOptionalDescription
skuIdSnowflakeNoThe SKU id to fetch subscription for
subscriptionIdSnowflakeNoThe subscription id to fetch
optionsPick<RequestData, 'signal'>YesThe options for fetching the subscription
getSKUSubscriptions(skuId, query, options?):Promise<RESTGetAPISKUSubscriptionsResult>
NameTypeOptionalDescription
skuIdSnowflakeNoThe SKU id to fetch subscriptions for
queryRESTGetAPISKUSubscriptionsQueryNoThe query options for fetching subscriptions
optionsPick<RequestData, 'signal'>YesThe options for fetching subscriptions