POST

Get Quota


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.

Endpoint
POST
{DEPLOYMENT-URI}/v1/get-quota
Request
This endpoint does not take any parameters.
Response Object
quotaQuota

Required if quotaEnabled is true in the configuration*. Information about remaining credit in the plan.

Get quota
Request
cURL
curl POST https://www.provider.example.com/v1/get-quota \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "quota": { "remaining": 9, "limit": 10, "startDate": "2022-11-04T07:04:35Z", "endDate": "2022-11-05T07:04:35Z", "paidPlan": false } }
Errors
QuotaLimitReachedobjectstatus code: 429
MissingTokenobjectstatus code: 401
Did this help?