I've run out of included credits/quota: what happens and how to check your status

Symptom

A document generation request fails with a quota-related error, or the WordPress plugin shows a warning that the plan’s included quota has been exhausted.

Cause

Every POP plan includes a number of monthly operations (“credits”) consumed on use. Locally generating a document (XML, PDF, UBL, FA(3)) never consumes a credit: only the following operation, when there is one, consumes it, i.e. sending to a channel (SdI, PEPPOL, KSeF, Zoho, Fatture in Cloud, Aruba, SdI via PEC), webhook delivery, emailing the PDF, or legal preservation. When the included quota runs out:

• if your plan does not include overquota (extra use beyond what’s included), new requests are rejected until the cycle renews or you upgrade;
• if your plan does include overquota and it’s enabled on your account, extra usage continues but may be billed automatically, up to a monthly cap configured on your account.

Check your account status

GET /wp-json/api/v2/overquota-policy (authenticated with your license_key) returns the full status: included quota (included_quota), quota already used (used_quota), whether overquota is enabled (overquota_enabled/effective_overquota_enabled), the rate per extra request configured on your account (rate_eur), and the monthly cap (monthly_cap_eur), plus a readable status message (status_message) with the suggested action (suggested_action).

Fix

• Quota exhausted, overquota not enabled: wait for the monthly cycle to renew, or upgrade the plan from popapi.io > Account.
• Overquota enabled but you’ve reached the configured monthly cap: extra requests are blocked until the cycle renews or the cap is raised, contact support to review your account’s monthly cap.
• No valid payment method on file: chargeable overquota requires a valid Stripe payment method saved on the account, add one from the account panel before extra usage can continue.
• You have an overquota balance to settle: if an overquota order from a previous cycle has been unpaid for more than 30 days, new chargeable overquota is blocked until you settle it, check settlement_pending in the overquota-policy response or the payment status from the account panel.
• You don’t know whether overquota is enabled on your account: it’s not a self-service option from the plugin, contact support to enable it or change its limits.

Related configuration

See api/overview for API call authentication.