Paywall

Replace candidate paywall configuration

Changed on

Atomically replace the candidate-access paywall (configuration + six offers). Matches the Board monetization form rules. Enabling requires candidate profiles, a ready hosted payment connection, and at least one nonzero enabled offer. Disabling schedules active recurring subscriptions to cancel at period end. Requires billing.manage and an Idempotency-Key header. Never accepts or returns Stripe identifiers.

put/paywall

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/paywall
  • Auth: HTTP bearer

Request body

object'candidate_paywall'
enabledboolean required
previewCountinteger required
lockHeadingstring required
lockDescriptionstring required
buttonTextstring required
disclaimerTextstring required
currencystring required
perMonthLabelstring required
savingsTemplatestring required

Response

The replaced candidate paywall resource.

object'candidate_paywall' required
enabledboolean required
previewCountinteger required
lockHeadingstring required
lockDescriptionstring required
buttonTextstring required
disclaimerTextstring required
currencystring required

ISO 4217 currency code, lowercase (e.g. usd).

perMonthLabelstring required
savingsTemplatestring required

Changes