Extension Config


To configure and customize your service plugin, you need to provide important details in the plugin.json configuration file.

Note

If you created your service plugin extension with the CLI, required fields are automatically populated for you.

Configuration Params
baseUristring

Base URL of your SEO implementation. Wix sends API requests to endpoints implemented using this URL.


landingPageUrlstring

Your website's landing page.


quotaEnabledboolean

Whether there is a quota limit in the service. When set to true, include the quota object in responses.


supportedCountryCodesArray<string>

List of countries you support for SEO analysis. 2-letter country code in ISO-3166 alpha-2 format.


upgradeUrlstring

URL of the page where users can purchase a paid plan. Wix offers a link to this page when you respond with a value of false in quota's paidPlan property.

Did this help?

getQuota( )


Important: This is a handler function. Implement it only as part of the service plugin.


This method requests information about remaining quota in the plan. A Wix user can purchase a paid plan from your site or utilize a free plan if you offer one. You provide information about the current plan including how many searches remain out of the total in the plan, the dates of the plan, and whether the user currently has a paid plan.

Wix calls this method when a Wix user opens the SEO page of the Dashboard.

Method Declaration
Copy
Method Parameters
payloadGetQuotaEnvelope
Returns
Return Type:GetQuotaResponse | Promise<GetQuotaResponse>
Errors
MissingTokenWixErrorclass
OutOfQuotaWixErrorclass
Did this help?