POST

Get Quota Info


This endpoint retrieves quota information for an action.

Wix calls this endpoint when a site contributor opens the Manage your automations quotas modal in the Automations dashboard. The response from this endpoint is displayed in the modal. The data is displayed based on the response body format. Learn more about quota display options.

Implementing this endpoint is optional. To implement it, select the endpoint under Action's service plugin Endpoints when editing your action in the app dashboard.

Notes:

  • Wix doesn't enforce action quota limits, it only displays them to the user. Enforcing quota limits is the action provider's responsibility.
Endpoint
POST
{DEPLOYMENT-URI}/v1/quota-info
Body Params
actionKeystringRequiredminLength 1

Action key as defined in your app's action configuration in the app dashboard. For example, send-email or generate-invoice.

Response Object
actionQuotaInfoActionQuotaInfo

Details about the quotas for your action.

Get Quota Info sent by Wix

Get Quota Info request with a sample response body

Request
cURL
curl -X POST https://provider.example.com/v1/quota-info \ -H 'user-agent: Wix' \ -H 'accept-encoding: gzip, deflate' \ -H 'content-type: text/plain; charset=utf-8' \ -d '{ "actionKey": "email-client", }'
Response
JSON
{ "enforced": true, "quotaInfo": [ { "plans": [ { "id": "email-marketing-1w23e-1ww34", "name": "Email Marketing" } ], "quotas": [ { "featureName": "Emails sent", "currentUsage": "346", "limit": "500", "renewalDate": "2023-01-12T01:20:00.000Z" } ], "upgradeCta": { "url": "some link to upgrade", "label": "Upgrade Email Plan" } } ] }
Did this help?