Get Customer Paywall Status
Returns whether a specific customer currently has an unrecovered past-due payment, and the total amount owed.
Use this to power an in-app prompt that asks a past-due customer to update their payment method. The bundled revtain-paywall.js snippet calls this endpoint for you; you can also call it directly.
Authentication: this endpoint accepts your publishable key (rev_pk_...) in the X-API-KEY header, so it is safe to call from client-side code. Your secret API key also works for server-side calls.
Documentation Index
Fetch the complete documentation index at: https://docs.revtain.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Your Revtain API key (format: rev_xxx). Provided during onboarding.
Query Parameters
The customer's email address — the same value passed as customerEmail on /api/recovery/execute.
Response
Paywall status
Whether the customer currently has one or more unrecovered failed payments.
true
Total outstanding across all unrecovered failed payments, in the smallest currency unit.
4900
"USD"
Number of unrecovered failed payments for this customer.
1
Timestamp of the oldest unrecovered failure. Null when the customer is not past due.
"2026-05-14T09:12:00.000Z"