Paid Skill Schemas

The paidSkillInformation object is a JSON representation of the paid skill information shown on the TOOLS > MONETIZE YOUR SKILL section of the developer console. This object contains the purchase details for a paid skill. The skill manifest for paid skills has the same general format as for other custom skills. For the overall format of the skill manifest for all Alexa skills, see Skill Manifest Schema.

To specify paid skills, include the paidSkillInformation object within publishingInformation field and the customProductPrompts object within the locales field.

Copied to clipboard.

{
  "manifestVersion": "1.0",
  "publishingInformation": {
    "paidSkillInformation": {
        "pricing": {
            "amazon.com": [
                {
                    "offerType": "SUBSCRIPTION",
                    "freeTrialInformation": {
                        "freeTrialDuration": "P1D"
                    },
                    "subscriptionInformation": {
                        "subscriptionPaymentFrequency": "MONTHLY"
                    },
                    "price": 4.99,
                    "currency": "USD"
                }
            ],
            "amazon.co.uk": [
                {
                    "offerType": "SUBSCRIPTION",
                    "freeTrialInformation": {
                        "freeTrialDuration": "P1D"
                    },
                    "subscriptionInformation": {
                        "subscriptionPaymentFrequency": "MONTHLY"
                    },
                    "price": 4.99,
                    "currency": "GBP"
                }
            ]
        },
        "taxInformation": {
            "category": "SOFTWARE"
        }
    },
    "locales": {
      "en-US": {
        "customProductPrompts": {
          "purchasePromptDescription": "Quick Trivia has come to Alexa! Challenge yourself to new trivia categories every month.",
          "purchaseConfirmationDescription": "Enjoy your Quick Trivia voice experience!"
        }
      }
    }
  }
}

PublishingInformation definition for paid Skills

In paid skills, include the following fields in the publishingInformation object.

Field Description

locales

A map of locale objects that provide specific information for each supported locale. Within the locales object, include the customProductPrompts object to define purchase prompts.

paidSkillInformation

Defines a skill as a paid skill. The paidSkillInformation object contains pricing and tax information.

customProductPrompts definition

The customProductPrompts object contains the prompts for paid skills.

Field Description Type

purchasePromptDescription

The description that a customer hears when they purchase a paid skill or cancel a subscription to a paid skill.
Follows these guidelines for the purchase description:

  • Include the skill name. Use "{PREMIUM_CONTENT_TITLE}" as a token for the display name. Don't use "{" or "}" anywhere else in the prompt.
  • Include what's unique about this skill.
  • Be as brief as possible.
  • Don't include any pricing information, as Amazon automatically appends the price in the purchase flow.
  • Avoid repeating the same phrases customers might have heard in the purchase suggestion.
  • Clearly explain what the skill provides.

string

purchaseConfirmationDescription

The description that displays on the post-purchase confirmation card in the Alexa app. Include the placeholder "{PREMIUM_CONTENT_TITLE}" for the skill name.

string

The paidSkillInformation object contains pricing and tax information.

Field Description Type

pricing

Specifies the purchase details

Pricing object

taxInformation

The tax category

TaxInformation object

Pricing object

The Pricing object contains an array of supported marketplaces.

Field Description Type

marketplaces

The marketplaces in which the skill is available for purchase. The field name is the marketplace name, such as "amazon.com". For valid values, see Paid skill marketplaces.

array of Price objects

Price object

Field Description Type

offerType

Specifies the payment model, such as subscription or one-time payment (entitlement).
Valid values: SUBSCRIPTION, ENTITLEMENT

string

freeTrialInformation

(Optional) Include to allow access to paid content for free. Exclude for entitlement offer types.

FreeTrialDuration field

subscriptionInformation

(Optional) Defines the payment cycle for subscription offer types. Exclude for entitlement offer types.

subscriptionPaymentFrequency field

price

The list price of the paid skill.
For minimum and maximum price ranges, see Price ranges for paid skills.

A number (long)

currency

The currency of the list price. Specify as a 3-digit ISO 4217 currency code.

string

freeTrialDuration field

Field Description Type

freeTrialDuration

The duration of the free trial in days.
Specify duration in ISO 8601 format. For example: "P7D". Valid duration: 1&endash;31 days, inclusive.

string

subscriptionPaymentFrequency field

Field Description Type

subscriptionPaymentFrequency

Identifies the frequency of recurring payments.
Valid values: MONTHLY, YEARLY

string

TaxInformation object

Field Description Type

category

Identifies the paid skill tax category.
Valid values: INFORMATION_SERVICES, NEWSPAPERS, PERIODICALS, SOFTWARE, STREAMING_AUDIO, STREAMING_RADIO, VIDEO

string

Sample paid skill

Copied to clipboard.

{
    "manifestVersion": "1.0",
    "publishingInformation": {
        "paidSkillInformation": {
            "pricing": {
                "amazon.com": [
                    {
                        "offerType": "SUBSCRIPTION", 
                        "freeTrialInformation": {
                            "freeTrialDuration": "P1D"
                        },
                        "subscriptionInformation": {
                            "subscriptionPaymentFrequency": "MONTHLY"
                        },
                        "price": 4.99,
                        "currency": "USD"
                    }
                ],
                "amazon.co.uk": [
                    {
                        "offerType": "ENTITLEMENT",
                        "freeTrialInformation": {
                            "freeTrialDuration": "P7D"
                        },
                        "price": 49.99,
                        "currency": "GBP"
                    }
                ]
            },
            "taxInformation": {
                "category": "SOFTWARE"
            }
        },
        "locales": {
            "en-US": {
                "name": "Quick Trivia",
                "summary": "Quick Trivia offers 10 trivia categories with new categories every month.",
                "description": "This funfilled game offers 10 trivia categories with new categories every month. You can choose between easy, medium, and hard questions.",
                "smallIconUri" : "https://smallUri.com",
                "largeIconUri" : "https://largeUri.com",
                "customProductPrompts": {
                    "purchasePromptDescription": "Quick Trivia has come to Alexa! Challenge yourself with new trivia categories every month.",
                    "boughtCardDescription": "Enjoy your Quick Trivia challenge!"
                },
                "examplePhrases": ["Alexa, open Quick Trivia", "Hey Quick Trivia, give me an easy question"],
                "keywords": ["trivia", "alexa", "questions", "challenge"]
            },
            "en-GB": {
                "name": "Quick Trivia",
                "summary": "Quick Trivia offers 10 trivia categories with new categories every month.",
                "description": "This funfilled game offers 10 trivia categories with new categories every month. You can choose between easy, medium, and hard questions.",
                "smallIconUri" : "https://smallUri.com",
                "largeIconUri" : "https://largeUri.com",
                "customProductPrompts": {
                    "purchasePromptDescription": "Quick Trivia has come to Alexa! Challenge yourself with new trivia categories every month.",
                    "boughtCardDescription": "Enjoy your Quick Trivia challenge!"
                },
                "examplePhrases": ["Alexa, open Quick Trivia", "Hey Quick Trivia, give me an easy question"],
                "keywords": ["trivia", "alexa", "questions", "challenge"]
            },
        },
        "distributionCountries": ["US", "GB"],
        "isAvailableWorldwide": false,
        "testingInstructions": "1) Say 'Alexa, buy Quick Trivia'",
        "category": "CUSTOM"
    },
    "privacyAndCompliance": {
        "allowsPurchases": true,
        "usesPersonalInfo": false,
        "isChildDirected": false,
        "isExportCompliant": true,
        "locales": {
            "en-US": {
                "privacyPolicyUrl": "http://www.myprivacypolicy.sampleskill.com",
                "termsOfUseUrl": "http://www.termsofuse.sampleskill.com"
            },
            "en-GB": {
                "privacyPolicyUrl": "http://www.myprivacypolicy.sampleskill.co.uk",
                "termsOfUseUrl": "http://www.termsofuse.sampleskill.co.uk"
            },
        }
    }
}