No summary provided.
Constructs a new instance of the
MonetizationAPI class| Name | Type | Optional | Description |
|---|---|---|---|
| rest | REST | No | None |
Marks a given entitlement for the user as consumed. Only available for One-Time Purchase consumable SKUs.
| Name | Type | Optional | Description |
|---|---|---|---|
| applicationId | Snowflake | No | The application id to consume the entitlement for |
| entitlementId | Snowflake | No | The entitlement id to consume |
| options | Pick<RequestData, 'signal'> | Yes | The 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.
| Name | Type | Optional | Description |
|---|---|---|---|
| applicationId | Snowflake | No | The application id to create the entitlement for |
| body | RESTPostAPIEntitlementJSONBody | No | The data for creating the entitlement |
| options | Pick<RequestData, 'signal'> | Yes | The options for creating the entitlement |
Deletes a test entitlement for an application's SKU.
| Name | Type | Optional | Description |
|---|---|---|---|
| applicationId | Snowflake | No | The application id to delete the entitlement for |
| entitlementId | Snowflake | No | The entitlement id to delete |
| options | Pick<RequestData, 'signal'> | Yes | The options for deleting the entitlement |
Fetches an entitlement for an application.
| Name | Type | Optional | Description |
|---|---|---|---|
| applicationId | Snowflake | No | The application id to fetch the entitlement for |
| entitlementId | Snowflake | No | The entitlement id to fetch |
| options | Pick<RequestData, 'signal'> | Yes | The options for fetching the entitlement |
Fetches the entitlements for an application.
| Name | Type | Optional | Description |
|---|---|---|---|
| applicationId | Snowflake | No | The application id to fetch entitlements for |
| query | RESTGetAPIEntitlementsQuery | Yes | The query options for fetching entitlements |
| options | Pick<RequestData, 'signal'> | Yes | The options for fetching entitlements |
Fetches the SKUs for an application.
| Name | Type | Optional | Description |
|---|---|---|---|
| applicationId | Snowflake | No | The application id to fetch SKUs for |
| options | Pick<RequestData, 'signal'> | Yes | The options for fetching the SKUs. |
Fetches a subscription for an SKU.
| Name | Type | Optional | Description |
|---|---|---|---|
| skuId | Snowflake | No | The SKU id to fetch subscription for |
| subscriptionId | Snowflake | No | The subscription id to fetch |
| options | Pick<RequestData, 'signal'> | Yes | The options for fetching the subscription |
Fetches subscriptions for an SKU.
| Name | Type | Optional | Description |
|---|---|---|---|
| skuId | Snowflake | No | The SKU id to fetch subscriptions for |
| query | RESTGetAPISKUSubscriptionsQuery | Yes | The query options for fetching subscriptions |
| options | Pick<RequestData, 'signal'> | Yes | The options for fetching subscriptions |