Sign in

v3

latestOpenAPI 3.0.32026-08-05363479.3 KB

Create a draft provider-funded action offer

Terms-only launch pilot. Drafts cannot appear beside organic results until the provider authenticates the exact capped CPA terms, the owner verifies that acceptance, and NHS activates the offer.

post/provider/offers

Request body

claim_idstring uuid required
namestring required
summarystring required
action_type'lead' | 'demo' | 'trial' | 'signup' | 'purchase' | 'quote' | 'application' | 'booking' required
action_urlstring uri required

HTTPS URL on the verified provider domain

charge_event'accepted' | 'activated' | 'converted' required
bounty_centsinteger required
currency'usd' required
principal_price_mode'free' | 'fixed' | 'quote' | 'provider_pricing' required
principal_price_centsinteger
principal_currency'usd' required
billing_mode'terms' required

The bounded launch pilot supports provider-authenticated exact capped CPA terms only; prepaid collection is not launched

terms_credit_limit_centsinteger
terms_period_daysinteger

Response

Draft offer created