Creating SKUs for the Mini Apps Partner Program
Define display names and SKUs for one-time charges and subscriptions in the Mini Apps Partner Program.
Overview
If your app supports the Mini Apps Partner Program, use the Advanced Commerce APIs when a customer initiates a one-time purchase (OneTimeChargeCreateRequest), or purchases a subscription (SubscriptionCreateRequest).
The Mini Apps Partner Program has specific requirements for defining the SKUs and the product display names, so they fully identify each mini app product. Follow these guidelines to create display names and SKUs for products you offer through the Mini Apps Partner Program and describe the format for one-time purchases and subscriptions. See Creating SKUs for your In-App Purchases for additional guidance.
Describe the mini app and mini apps partner with metadata
The following table lists the identifiers that make up mini app display names and SKUs.
Identifier | Description | Example |
|---|---|---|
| The name of the mini app |
|
| The name of the product associated with the mini app |
|
| The name of the mini app partner |
|
| The unique identifier you set for the mini app partner |
|
| The unique identifier you set for the Mini App Product |
|
You determine the names and concatenate them to create the display names and SKUs, as specified in the one-time or subscription purchase instructions below, when you use the Advanced Commerce APIs to initiate purchases.
Initiate a one-time charge purchase
To initiate a one-time charge for a mini app product, use the OneTimeChargeCreateRequest.
Create the mini app display name using the format [Mini App Name] - [Mini App Product Name]. Using the sample values from the table above, item.displayName would look like the following example:
item.displayName = "Anne’s Game - Boost Pack"The display name can use a maximum of 30 characters.
The two elements are separated by the ‘-’ character, with a single space on either side of the ‘-’ character.
Create the item.SKU using the format [Mini App SKU Identifier]|[Mini App Partner Name]|[Mini App Partner ID]
Using the sample values from the table above, the items.SKU would look like the following example:
item.SKU = "boost_pack_id |Apple_Seed|WC123"The SKU value needs to be unique within your app and can use a maximum of 128 characters.
All three elements are separated by the ‘|’ character and all three elements must be present.
Initiate a subscription purchase
To initiate a subscription purchase, use the SubscriptionCreateRequest API.
Create the display name and SKU in SubscriptionCreateItem to include the specified details and ensure it conforms to the indicated formatting and length limitations.
The mini app’s display name can use a maximum of 30 characters, and follows this format: descriptors.displayName = [Mini App Name], for example
descriptors.displayName = "Anne's Game"The product display name can use a maximum of 30 characters and follow this format: items.displayName = [Mini App Product Name], for example
items.displayName = "Pro Monthly"The SKU value needs to be unique within your app and can use a maximum of 128 characters and follows this format: items.SKU = [Mini App SKU Identifier]|[Mini App Partner Name]|[Mini App Partner ID], for example
items.SKU = "pro_monthly_id|Apple_Seed|WC123"All three elements are separated by the ‘|’ character and all three elements must be present.