Integration Guide

• Documentation review — 15 minutes
  Learn about the endpoints available on the Modern Pricing API and what a typical request looks like.
  View API Documentation.

• Document pricing mentions — 30 minutes
  Review and document all of the places where you currently hard-code prices on your website. We're happy to help complete this task with you.

• Create pricing plans — 15 minutes
  We recommend creating four tiers of pricing plans—"low","middle","high", and "ultra"—which correspond to the valid responses from the Modern Pricing API.

Example:

• Request a score — 15 minutes
  Make a request to score your website visitor. Be sure to pass along the visitor's IP Address at a minimum, and the User Agent for even better results.



curl -X POST "https://modernpricing.com/v1/scores" \
-H "Authorization: Basic your-api-key-goes-here" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"ip_address":"67.243.228.40",
     "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)"}'



• Save the score — 30 minutes
  By saving the score to your user record, you'll ensure that the user sees a consistent price for the remainder of their customer journey.



# == Schema Information
#
# Table name: users
#
# id                :bigint(8)
# first_name  :string
# last_name  :string
# email          :string
.
.
.
# score          :string
#




• Add control flow statements on checkout — 30 minutes
  Control flow statements on your checkout page are the final step for changing from static to dynamic pricing. Change the price based on the user's score—it's that simple.



// Pseudo code:
case score
when 'low'
...
when 'middle'
...
when 'high'
...
when 'ultra'
...
when 'unknown'
...
end

• Filter bot traffic — 30 minutes
  Note: If you integrate with our JavaScript snippet, we've taken care of this for you already.
  
  We recommend you check to make sure the visitor to your website is not a bot before making a request to Modern Pricing.
  
  If you skip this step, we still accept your API requests from bot visitors and return the score, "bot". However, this will count against your monthly API request volume.



// Pseudo code:
if User Agent is a bot
  score = 'bot'
else
... request Modern Pricing score
end

Have you...

• Documented all the places where you currently mention price information?
• Created pricing plans that correspond to Modern Pricing scores?
• Implemented the Modern Pricing API — via our JavaScript snippet or HTTP?
• Filtered bot traffic requests (not necessary if using our JavaScript snippet)?

If you answered yes to all of these questions, you're ready for release!