<!DOCTYPE html>
<html>

<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="_csrf" value="">
  <link rel="icon" href="https://cdn.revcent.com/img/favicon.png">
  <title>RevCent API Documentation</title>
  <meta name="description" content="RevCent API documentation." />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/bootstrap.min.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/fontawesome-5/css/all.css">
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/fontawesome-5/css/v4-shims.css">
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/lightbox/ekko-lightbox.min.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/bootstrap-markdown/bootstrap-markdown.min.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/bootstrap-select/bootstrap-select.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/json-forms/json-forms.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/highlightjs/lightfair.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/datatables/datatables.min.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/animate.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/sweetalert/sweetalert.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/switchery/switchery.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/daterangepicker/daterangepicker.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/multiselect/multiselect.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/toastr/toastr.min.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/yamm/yamm.css" type="text/css" />
  <link rel="stylesheet" href="https://cdn.revcent.com/css/revcent.min.css?ver=6" type="text/css" />


 <style>
   body {
     position: relative;
   }

   .api-section-img {
     margin-top: 20px;
   }

   .api-section-img .img-thumbnail {
     border: none;
     margin-left: -15px;
   }

   .label-doc {
     font-size: 12px;
     color: #999;
   }

   .label-doc-required {
     text-transform: uppercase;
     color: #23c6c8;
   }

   .label-doc-optional {
     text-transform: uppercase;
   }

   #introduction .api-section-code {
     padding-top: 40px;
   }

   #introduction .api-section-text {
     padding-top: 0px;
   }

   .api-section {
     display: -webkit-box;
     display: -webkit-flex;
     display: -ms-flexbox;
     display: flex;
   }

   .api-section-col {
     padding-top: 50px;
   }

   .api-section-col.last-section {
     padding-bottom: 100px;
   }

   .api-section-code-col.with-tabs {
     padding-top: 90px;
   }

   .api-section-text {
     margin-top: 10px;
   }

   .api-section-text h4 {
     margin-top: 40px;
   }

   .api-section-code-col {
     color: #d0d0d0;
     background: #2d3134;
     padding-bottom: 10px;
   }

   .api-section-code-col pre {
     color: #d0d0d0;
     background-color: #272b2d;
     border: 0px solid #ccc;
     overflow: scroll;
   }


   #sidebar {
     bottom: 0;
     left: 0;
     top: 0;
     z-index: 75;
     width: 220px;
     background: #fafcfc;
     border-right: 1px solid #f0f4f7;
   }

   #sidebar #sidebar-nav-header {
     bottom: 0;
     left: 0;
     top: 0;
     width: 15.3%;
     right: 0;
     background-color: #efefef;
     z-index: 999;
     position: fixed;
     height: 48px;
   }

   #sidebar #sidebar-nav-wrap {
     bottom: 0;
     left: 0;
     top: 48px;
     right: 0;
     position: fixed;
     overflow: scroll;
     width: 15.3%;
     background-color: #f9f9f9;
     padding-top: 30px;
   }

   #main-doc-content {
     bottom: 0;
     left: 16.7%;
     right: 0;
     overflow: scroll;
     position: fixed;
     top: 50px;
   }

   .api-text-divider {
     min-height: 50px;
   }

   #api-code-nav {
     background: #242729 !important;
     color: #d0d4d7;
     left: 58.36%;
     border-bottom: 0px solid #e7eaec !important;
   }

   p {
     margin: 0 0 10px;
     line-height: 1.7;
   }

   .col-code-p {
     margin-top: 20px;
   }

   .col-code-first {
     margin-top: 30px;
   }

   .col-code-p.col-code-additional {
     margin-top: 30px;
   }


   #api-code-nav-wrap .nav>li>a {
     font-weight: 400;
     padding: 14px 20px 14px 20px;
   }


   #sidebar .nav>li.active {
     border-left: 0px;
   }

   #sidebar .nav>li>a {
     color: #2d3134;
     font-weight: 600;
     font-size: 14px;
     padding: 10px 20px 10px 20px;
   }

   #sidebar .nav>li.active>a {
     color: #fff;
     background-color: #00c5c5;
   }

   #sidebar .nav>li.active>a:hover {
     background-color: #00c5c5;
   }

   #main-doc-sidebar.nav .nav {
     display: none;
     font-size: 12px;
   }

   #main-doc-sidebar.nav>.active>ul {
     display: block;
   }

   #main-doc-sidebar.nav>.active>ul>li>a {
     padding: 10px 10px 10px 30px;
     font-weight: 400;
     font-size: 13px;
   }

   #main-doc-sidebar.nav>.active>ul {
     display: block;
     background-color: #f1f1f1;
   }

   #main-doc-sidebar.nav>.active>ul>li.active>a {
     background: #00c5c5;
   }

   #main-doc-sidebar.nav>.active>ul>li.active {
     background: #f1f1f1;
   }

   #main-doc-sidebar.nav>.active>ul.nav>.active>ul {
     display: block;
   }

   #main-doc-sidebar.nav>.active>ul.nav>.active>ul>li>a {
     padding: 10px 20px 10px 50px;
     font-weight: 400;
     font-size: 13px;
   }

   #main-doc-sidebar.nav>.active>ul>li.active>ul>li.active>a {
     background: #00c5c5;
   }

   #main-doc-sidebar.nav>.active>ul>li.active>ul>li.active {
     background: #f1f1f1;
   }

   #main-doc-sidebar.nav>.active>ul.nav>.active>ul>li.active>ul {
     display: block;
   }

   #main-doc-sidebar.nav>.active>ul.nav>.active>ul>li.active>ul>li>a {
     padding: 10px 20px 10px 70px;
     font-weight: 400;
     font-size: 13px;
   }

   .properties-collapse {
     border-radius: 4px;
     border: 1px solid #eee;
     padding: 10px 0px;
     margin-top: 10px;
   }

   .properties-collapse hr {
     border-top: 1px solid #eee;
   }

   .properties-collapse hr.card-block-first {
     margin-top: 10px;
   }

   .properties-collapse hr.card-block-last {
     margin-top: 10px;
     margin-bottom: 10px;
     border-top: 0px solid #eee;
   }

   .properties-collapse .show-properties-toggle {
     color: #337ab7;
     font-size: 13px;
   }

   .or-label {
     color: #999999;
   }

   .card-block .card.sub-card {
     margin: 0px 20px;
   }

   .white-bg {
     background-color: #ffffff !important;
   }

   @media (max-width: 768px) {
     .api-section-code-col {
       display: block;
     }

     .api-section {
       display: block;
     }

     .api-section-code-col.no-content {
       display: none;
     }

     .schema-property-key {
       text-align: left;
       margin-bottom: 10px;
     }

     .card-block .schema-property-key,
     .card-block .schema-property-value {
       padding-left: 25px;
       padding-right: 25px;
     }

     #main-doc-content {
       left: 0%;
     }

     .sidebar-nav-col {
       display: none;
     }
   }

   .navbar-public {
     border-bottom: 0px !important;
     box-shadow: 1px 1px 1px rgba(0, 0, 0, 0.3);
     z-index: 2030;
     border-radius: 0px;
   }

   .navbar-default {
     background-color: #ffffff;
   }

   section h1,
   section h2,
   section h3 {
     font-weight: 500;
   }
 </style>
<link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/code-prettify/tron.css" type="text/css" />
<style>
    .docs-query-section {
        display: none !important;
    }

    .public-body .navbar-default .navbar-nav>li>a {
        color: #192335;
        font-weight: 600;
        font-size: 15px;
    }
    .nav-text span{
        display: block;
        /* color: #192335; */
        font-size: 15px;
        font-weight: 600;
        height: 50px;
        padding: 14px 20px 14px 20px;
    }
</style>
</head>

<body class="white-bg public-body" id="docs-api-page">

    <nav class="navbar public-navbar navbar-public yamm navbar-default">
        <div class="container-fluid">
            <div class="navbar-header navbar-header-public">
                <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
                    <span class="sr-only">Toggle navigation</span>
                    <span class="icon-bar"></span>
                    <span class="icon-bar"></span>
                    <span class="icon-bar"></span>
                </button>
                <a href="/"><img src="https://cdn.revcent.com/img/revcent-logo-black.png" alt="RevCent Logo" style="max-height: 21px;margin-top: 14px;margin-right: 10px;"></a>
                <span class="text-muted small" style="font-weight: 400;margin-left:10px;vertical-align: bottom;">API V1</span>
            </div>
            <div id="navbar" class="navbar-collapse collapse" aria-expanded="false" style="height: 1px;">
                <ul class="nav navbar-nav navbar-right">
                    <li><a href="https://kb.revcent.com/" target="_blank">Knowledge Base <i class="far fa-external-link-square-alt small"></i></a></li>
                    <li><a href="/contact">Contact</a></li>
                </ul>
            </div>
        </div>
    </nav>

    <div class="wrapper">
        <div class="row">
            <div class="col-sm-2 sidebar-nav-col">
                <div id="sidebar">
                    <div id="sidebar-nav-wrap">
                        <ul class="nav nav-stacked sidebar-nav" id="main-doc-sidebar" style="margin-bottom:80px">
                            <li>
                                <a href="#introduction">Introduction</a>
                            </li>
                            <li>
                                <a href="#authentication">Authentication</a>
                            </li>
                            <li>
                                <a href="#api-request-body">Body</a>
                            </li>
                            <li>
                                <a href="#api-request-example-curl">Example</a>
                            </li>
                            <li>
                                <a href="#api-request-idempotency">Idempotent Requests</a>
                            </li>
                            <hr>
                            <li class="hidden">
                                <a href="#api-call">API Call</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#api-call-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#campaign">Campaign</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#campaign-create">Create</a>
                                    </li>
                                    <li>
                                        <a href="#campaign-edit">Edit</a>
                                    </li>
                                    <li>
                                        <a href="#campaign-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#chargeback">Chargeback</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#chargeback-create">Create</a>
                                    </li>
                                    <li>
                                        <a href="#chargeback-edit">Edit</a>
                                    </li>
                                    <li>
                                        <a href="#chargeback-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#coupon">Coupon</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#coupon-validate">Validate</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#customer">Customer</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#customer-create">Create</a>
                                    </li>
                                    <li>
                                        <a href="#customer-edit">Edit</a>
                                    </li>
                                    <li>
                                        <a href="#customer-enable">Enable</a>
                                    </li>
                                    <li>
                                        <a href="#customer-disable">Disable</a>
                                    </li>
                                    <li>
                                        <a href="#customer-add-card">Add Card</a>
                                    </li>
                                    <li>
                                        <a href="#customer-add-to-group">Add To Group</a>
                                    </li>
                                    <li>
                                        <a href="#customer-remove-from-group">Remove From Group</a>
                                    </li>
                                    <li>
                                        <a href="#customer-retrieve">Retrieve</a>
                                    </li>
                                    <li>
                                        <a href="#customer-search">Search</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#customer-card">Customer Card</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#customer-card-add">Add</a>
                                    </li>
                                    <li>
                                        <a href="#customer-card-enable">Enable</a>
                                    </li>
                                    <li>
                                        <a href="#customer-card-disable">Disable</a>
                                    </li>
                                    <li>
                                        <a href="#customer-card-delete">Delete</a>
                                    </li>
                                    <li>
                                        <a href="#customer-card-set-default">Set Default</a>
                                    </li>
                                    <li>
                                        <a href="#customer-card-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#discount">Discount</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#discount-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#fraud">Fraud</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#fraud-alert">Alert</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#fraud-alert-add">Add</a>
                                            </li>
                                            <li>
                                                <a href="#fraud-alert-remove">Remove</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#fraud-detection">Detection</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#fraud-detection-create">Create</a>
                                            </li>
                                            <li>
                                                <a href="#fraud-detection-edit">Edit</a>
                                            </li>
                                            <li>
                                                <a href="#fraud-detection-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#fraud-detection-request">Detection Request</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#fraud-detection-request-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#gateway">Gateway</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#site-gateway">Site Gateway</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#site-gateway-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#user-gateway">User Gateway</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#user-gateway-create">Create</a>
                                            </li>
                                            <li>
                                                <a href="#user-gateway-edit">Edit</a>
                                            </li>
                                            <li>
                                                <a href="#user-gateway-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#gateway-group">Gateway Group</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#gateway-group-create">Create</a>
                                            </li>
                                            <li>
                                                <a href="#gateway-group-edit">Edit</a>
                                            </li>
                                            <li>
                                                <a href="#gateway-group-add-user-gateway">Add User Gateway</a>
                                            </li>
                                            <li>
                                                <a href="#gateway-group-remove-user-gateway">Remove User Gateway</a>
                                            </li>
                                            <li>
                                                <a href="#gateway-group-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#payment-profile">Payment Profile</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#payment-profile-create">Create</a>
                                            </li>
                                            <li>
                                                <a href="#payment-profile-edit">Edit</a>
                                            </li>
                                            <li>
                                                <a href="#payment-profile-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#invoice">Invoice</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#invoice-create">Create</a>
                                    </li>
                                    <li>
                                        <a href="#invoice-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#license-key">License Key</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#license-key-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#metadata">Metadata</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#metadata-insert">Insert</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#note">Note</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#note-create">Create</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#payments">Payments</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#check-direct">Check Direct</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#check-direct-refund">Refund</a>
                                            </li>
                                            <li>
                                                <a href="#check-direct-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#credit-card">Credit Card</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#transaction">Transaction</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#transaction-create-refund">Create Refund</a>
                                                    </li>
                                                    <li>
                                                        <a href="#transaction-retrieve">Retrieve</a>
                                                    </li>
                                                    <li>
                                                        <a href="#transaction-search">Search</a>
                                                    </li>
                                                </ul>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#offline-payment">Offline</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#offline-payment-refund">Refund</a>
                                            </li>
                                            <li>
                                                <a href="#offline-payment-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#paypal">PayPal</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#paypal-dispute">Dispute</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#paypal-dispute-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                            <li>
                                                <a href="#paypal-transaction">Transaction</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#paypal-transaction-refund">Refund</a>
                                                    </li>
                                                    <li>
                                                        <a href="#paypal-transaction-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                        </ul>
                                    </li>

                                </ul>
                            </li>
                            <li>
                                <a href="#pending-refund">Pending Refund</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#pending-refund-process">Process</a>
                                    </li>
                                    <li>
                                        <a href="#pending-refund-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#product">Product</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#product-create">Create</a>
                                    </li>
                                    <li>
                                        <a href="#product-edit">Edit</a>
                                    </li>
                                    <li>
                                        <a href="#product-enable">Enable</a>
                                    </li>
                                    <li>
                                        <a href="#product-disable">Disable</a>
                                    </li>
                                    <li>
                                        <a href="#product-delete">Delete</a>
                                    </li>
                                    <li>
                                        <a href="#product-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#product-sale">Product Sale</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#product-sale-refund">Refund</a>
                                    </li>
                                    <li>
                                        <a href="#product-sale-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <!-- <li>
                                <a href="#quota">Quota</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#quota-account">Account</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#quota-account-credit">Credit</a>
                                            </li>
                                            <li>
                                                <a href="#quota-account-debit">Debit</a>
                                            </li>
                                            <li>
                                                <a href="#quota-account-enable">Enable</a>
                                            </li>
                                            <li>
                                                <a href="#quota-account-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#quota-account-ledger-entry">Account Ledger Entry</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#quota-account-ledger-entry-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#quota-unit-group">Unit Group</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#quota-unit-group-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#quota-unit">Unit</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#quota-unit-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                </ul>
                            </li> -->
                            <li>
                                <a href="#sale">Sale</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#sale-create">Create</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#sale-create-credit-card">Credit Card</a>
                                            </li>
                                            <li>
                                                <a href="#sale-create-paypal">PayPal</a>
                                            </li>
                                            <li>
                                                <a href="#sale-create-check-direct">Check</a>
                                            </li>
                                            <li>
                                                <a href="#sale-create-offline-payment">Offline</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#sale-pending">Pending (Upsell)</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#sale-pending-create">Create</a>
                                            </li>
                                            <li>
                                                <a href="#sale-pending-update">Update</a>
                                            </li>
                                            <li>
                                                <a href="#sale-pending-process">Process</a>
                                            </li>
                                            <li>
                                                <a href="#sale-pending-cancel">Cancel</a>
                                            </li>
                                            <li>
                                                <a href="#sale-upsell">Upsell Profile</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#sale-void">Void</a>
                                    </li>
                                    <li>
                                        <a href="#sale-estimate">Estimate</a>
                                    </li>
                                    <li>
                                        <a href="#sale-retrieve">Retrieve</a>
                                    </li>
                                    <li>
                                        <a href="#sale-search">Search</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#salvage-transaction">Salvage Transaction</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#salvage-transaction-process">Process</a>
                                    </li>
                                    <li>
                                        <a href="#salvage-transaction-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#settlement">Settlement</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#settlement-create">Create</a>
                                    </li>
                                    <li>
                                        <a href="#settlement-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#shipping">Shipping</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#shipping-edit">Edit</a>
                                    </li>
                                    <li>
                                        <a href="#shipping-refund">Refund</a>
                                    </li>
                                    <li>
                                        <a href="#shipping-retrieve">Retrieve</a>
                                    </li>
                                    <li>
                                        <a href="#shipping-search">Search</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#shop">Shop</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#site-shop">Site Shop</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#site-shop-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#user-shop">User Shop</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#user-shop-create">Create</a>
                                            </li>
                                            <li>
                                                <a href="#user-shop-edit">Edit</a>
                                            </li>
                                            <li>
                                                <a href="#user-shop-validate">Validate</a>
                                            </li>
                                            <li>
                                                <a href="#user-shop-fix">Fix</a>
                                            </li>
                                            <li>
                                                <a href="#user-shop-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#subscription">Subscription</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#subscription-activate">Activate</a>
                                    </li>
                                    <li>
                                        <a href="#subscription-suspend">Suspend</a>
                                    </li>
                                    <li>
                                        <a href="#subscription-cancel">Cancel</a>
                                    </li>
                                    <li>
                                        <a href="#subscription-renew">Renew</a>
                                    </li>
                                    <li>
                                        <a href="#subscription-edit">Edit</a>
                                    </li>
                                    <li>
                                        <a href="#subscription-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#subscription-renewal">Subscription Renewal</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#subscription-renewal-refund">Refund</a>
                                    </li>
                                    <li>
                                        <a href="#subscription-renewal-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#tax">Tax</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#tax-refund">Refund</a>
                                    </li>
                                    <li>
                                        <a href="#tax-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#tracking">Tracking</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#googleadwords">AdWords</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#googleadwords-campaign">Campaign</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#googleadwords-campaign-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                            <li>
                                                <a href="#googleadwords-ad-group">Ad Group</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#googleadwords-ad-group-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                            <li>
                                                <a href="#googleadwords-ad">Ad</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#googleadwords-ad-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                            <li>
                                                <a href="#googleadwords-keyword">Keyword</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#googleadwords-keyword-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                            <li>
                                                <a href="#googleadwords-click">Click</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#googleadwords-click-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                            <li>
                                                <a href="#googleadwords-objects-retrieve">Response Objects</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#hosted-page">Hosted Page</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#hosted-page-visit">Hosted Page Visit</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#hosted-page-visit-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                            <li>
                                                <a href="#hosted-page-submission">Hosted Page Submission</a>
                                                <ul class="nav">
                                                    <li>
                                                        <a href="#hosted-page-submission-retrieve">Retrieve</a>
                                                    </li>
                                                </ul>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#tracking-visitor">Tracking Visitor</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#tracking-visitor-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#trial">Trial</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#trial-expire">Expire</a>
                                    </li>
                                    <li>
                                        <a href="#trial-cancel">Cancel</a>
                                    </li>
                                    <li>
                                        <a href="#trial-extend">Extend</a>
                                    </li>
                                    <li>
                                        <a href="#trial-shorten">Shorten</a>
                                    </li>
                                    <li>
                                        <a href="#trial-retrieve">Retrieve</a>
                                    </li>
                                </ul>
                            </li>
                            <!-- <li>
                                <a href="#usage">Usage</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#usage-account">Account</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#usage-account-enable">Enable</a>
                                            </li>
                                            <li>
                                                <a href="#usage-account-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#usage-account-invoice">Account Invoice</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#usage-account-invoice-charge">Charge</a>
                                            </li>
                                            <li>
                                                <a href="#usage-account-invoice-enable">Enable</a>
                                            </li>
                                            <li>
                                                <a href="#usage-account-invoice-estimate">Estimate</a>
                                            </li>
                                            <li>
                                                <a href="#usage-account-invoice-refund">Refund</a>
                                            </li>
                                            <li>
                                                <a href="#usage-account-invoice-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#usage-item">Item</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#usage-item-create-entry">Create Entry</a>
                                            </li>
                                            <li>
                                                <a href="#usage-item-enable">Enable</a>
                                            </li>
                                            <li>
                                                <a href="#usage-item-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#usage-item-invoice">Item Invoice</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#usage-item-invoice-enable">Enable</a>
                                            </li>
                                            <li>
                                                <a href="#usage-item-invoice-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#usage-item-entry">Item Entry</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#usage-item-entry-retrieve">Retrieve</a>
                                            </li>
                                        </ul>
                                    </li>
                                </ul>
                            </li>
                            <hr> -->
                            <li class="docs-query-section">
                                <a href="#query">Query</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#query-request">Request</a>
                                    </li>
                                    <li>
                                        <a href="#query-initial-response">Initial Response</a>
                                    </li>
                                    <li>
                                        <a href="#query-retrieve">Retrieve</a>
                                    </li>
                                    <li>
                                        <a href="#query-parameters">Parameters</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#query-type">Type</a>
                                            </li>
                                            <li>
                                                <a href="#query-analytic">Analytic</a>
                                            </li>
                                            <li>
                                                <a href="#query-group-by">Group By</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li>
                                        <a href="#query-examples">Examples</a>
                                        <ul class="nav">
                                            <li>
                                                <a href="#query-metric">Metric</a>
                                            </li>
                                            <li>
                                                <a href="#query-pie">Pie</a>
                                            </li>
                                            <li>
                                                <a href="#query-timeline">Timeline</a>
                                            </li>
                                        </ul>
                                    </li>
                                    <li class="hidden">
                                        <a href="#query-filters">Filters</a>
                                    </li>
                                </ul>
                            </li>
                            <hr>
                            <li>
                                <a href="#filters">Filters</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#filters-list">List</a>
                                    </li>
                                </ul>
                            </li>
                            <li>
                                <a href="#pagination">Pagination</a>
                                <ul class="nav">
                                    <li>
                                        <a href="#pagination-example">Example</a>
                                    </li>
                                </ul>
                            </li>
                        </ul>
                    </div>
                </div>            </div>
            <div class="col-sm-10" id="main-doc-content">
                <section id="introduction">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text introduction">
                                <h2>RevCent API V1</h2>
                                <hr>
                                </hr>
                                <p>You are viewing the Version 1 API Docs. If you are looking for the Version 2 API Docs, please <a href="/docs/api/v2">click here</a>.</p>
                                <p>
                                    The V1 API is a JSON based API. All calls are performed via http POST, with a JSON body, and application/json as the content type. This allows a coding language agnostic method of calling the V1 API without
                                    the need for an SDK. Simply call the V1 API endpoint using your authorization credentials in the header. All api calls must use the http POST method. Other http methods will be rejected. It is important to set the Content-Type in your POST header to "application/json".
                                </p>


                                <p style="margin-top:20px">
                                    <strong>V1 vs V2</strong>
                                    <br>
                                    The difference between the V1 API and V2 API is purely based on the need for an open standard interface. The V1 API does not follow an open standard for third parties to programatically integrate. The V2 API follows the OpenAPI 3.1 standard, allowing developers and third parties to programatically integrate using the specification file.
                                </p>

                                <p style="margin-top:20px">
                                    <strong>Which Should I Use?</strong>
                                    <br>
                                    If you are integrating with RevCent for the first time, we recommend using the V2 API and its specification. If you are currently using V1 API please continue to use it, as the V1 API will never be deprecated and any new API capabilities will be added to both V1 and V2 simultaneously.
                                </p>

                                <p style="margin-top:20px">
                                    <strong>Whitelist RevCent</strong>
                                    <br>
                                    All requests from RevCent will use the following IP addresses:
                                    <br><strong>34.224.171.255</strong>
                                    <br><strong>52.3.146.218</strong>
                                    <br><strong>54.174.155.188</strong>
                                </p>
                                <p style="margin-top:20px">
                                    If you need help please do not hesitate to <a href="/contact">contact us</a>.
                                </p>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code-null">
                                <p class="col-code-p col-code-first">API Endpoint</p>
                                <pre id="endpoint-request" class="highlight-code language-markdown">https://api.revcent.com/v1</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="authentication">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text authentication">
                                <h2>Authentication</h2>
                                <hr></hr>
                                <p>
                                    Each account has two API Keys, a live key and a test key. This allows you to test the API and view results using the test/live mode toggle in the user dashboard.
                                </p>
                                <p>
                                    Depending on the key used, RevCent will use the appropriate merchant gateway endpoint for test/live transactions. For example, if you use a test RevCent key we will use the test endpoint for the merchant gateway. A live RevCent key will use the live merchant
                                    gateway endpoint.
                                </p>
                                <p>
                                    The <strong>x-api-key</strong> should be in the header of the API request.
                                </p>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code-null">
                                <p class="col-code-p col-code-first">Example</p>
                                <pre id="authentication-request" class="highlight-code language-json">
"headers": { 
    "Content-Type": "application/json", 
    "x-api-key": "YOUR_REVCENT_API_KEY" 
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="api-request-body">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text api-request-body">
                                <h2>Request Body</h2>
                                <hr></hr>
                                <p>Every request body is a JSON object, containing the <i>request</i> object. The <i>request</i> object contains both <i>type</i> and <i>method</i> properties. This determines the actions that the specific POST request is going to perform.</p>
                                <p>In the example, the <i>type</i> is 'sale' and the <i>method</i> is 'retrieve'. Depending on the <i>type</i> and <i>method</i>, certain properties are required. All schema examples in the docs specify required properties depending on request.</p>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Example</p>
                                <pre id="api-request-request" class="highlight-code language-json">
{ 
    "request": {
        "type": "sale",
        "method": "retrieve",
        "id": "mJWJbKNQ4QI8XbwmyyW7"
    }
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="api-request-example-curl">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text">
                                <h2>Request Example</h2>
                                <hr></hr>
                                <p>The example contains a request using CURL showing the POST method, content-type header, x-api-key header and JSON body.</p>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Example</p>
                                <pre id="api-request-example-curl-code" class="highlight-code language-json">
curl --location --request POST 'https://api.revcent.com/v1' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_REVCENT_API_KEY' \
--data-raw '{
    "request": {
        "type": "sale",
        "method": "retrieve",
        "id": "mJWJbKNQ4QI8XbwmyyW7"
    }
}'</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="api-request-idempotency">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text">
                                <h2>Idempotent Requests</h2>
                                <hr>
                                </hr>
                                <p>The RevCent API supports idempotency for safely retrying API requests without performing the same specific operation twice.</p>
                                <p>This is useful for retrying disrupted requests while avoiding the chance of double charging a customer. To perform an idempotent request, provide the idempotency_key property within the request object. RevCent will check existing idempotency keys submitted within the past 24 hours for the API account. If an idempotency key match is found, the API request is immediately rejected and not saved.</p>
                                <p>The idempotency key must be at least 10 characters in length and can be up to 255 characters in length. We recommended you use V4 UUIDs. Retrieve requests ignore idempotency keys.</p>
                                <p><strong>Important:</strong> Only use idempotency keys if you know when and why to use them. Resubmitting the same idempotency key when purposely retrying a declined payment request will result in an error, and the retry payment will never be attempted.</p>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Example</p>
                                <pre id="api-request-request" class="highlight-code language-json">
{ 
   "request": {
       "type": "sale",
       "method": "create",
       "idempotency_key": "2c74f520-2b7f-44ea-b547-96e3fcaf7462",
       ...
   }
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <div id="docs-schema-content-wrap">
                    <section id="campaign" data-ordernum="0"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text campaign"><h2>Campaign</h2><hr></hr><p>A campaign is a way to group, categorize and filter various items within your account.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="campaign-create" data-ordernum="1"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text campaign-create"><h3>Campaign Create</h3><hr></hr><p>Create a new campaign.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">organization<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of one or more organization IDs.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">organization<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="campaign-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "campaign",
    "method": "create",
    "name": "New Name",
    "description": "Description.",
    "enabled": false,
    "organization": [
      "4rBAwPJzlPSg9lRwGVmX",
      "NkEzVWEdV7C9wvKn19Q8"
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="campaign-create-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-02T19:51:40+00:00",
  "api_call_id": "KnBKryj7jOFPLW1pqkVM",
  "api_call_processed": true,
  "api_call_unix": 1675367500,
  "campaign_id": "rmNPb2opoyfdBV4v0m7P",
  "campaign_name": "New Name",
  "code": 1,
  "organization": [
    {
      "id": "4rBAwPJzlPSg9lRwGVmX",
      "name": "AdWords Org"
    },
    {
      "id": "NkEzVWEdV7C9wvKn19Q8",
      "name": "Acme Org"
    }
  ],
  "request_method": "create",
  "request_type": "campaign",
  "result": "Campaign created."
}</pre></div></div></div></section><section id="campaign-edit" data-ordernum="2"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text campaign-edit"><h3>Campaign Edit</h3><hr></hr><p>Modify a campaign. Only provide the fields you wish to modify.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">organization<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of one or more organization IDs.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">organization<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="campaign-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "campaign",
    "method": "edit",
    "name": "Updated Name",
    "description": "Description.",
    "enabled": true,
    "campaign_id": "rmNPb2opoyfdBV4v0m7P",
    "organization": [
      "NkEzVWEdV7C9wvKn19Q8"
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="campaign-edit-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-02T19:51:04+00:00",
  "api_call_id": "9rwkYO1v7XFEB6mGdM8p",
  "api_call_processed": true,
  "api_call_unix": 1675367464,
  "campaign_id": "rmNPb2opoyfdBV4v0m7P",
  "code": 1,
  "organization": [
    {
      "id": "NkEzVWEdV7C9wvKn19Q8",
      "name": "Acme Org"
    }
  ],
  "request_method": "edit",
  "request_type": "campaign",
  "result": "Campaign edited."
}</pre></div></div></div></section><section id="campaign-retrieve" data-ordernum="3"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text campaign-retrieve"><h3>Campaign Retrieve</h3><hr></hr><p>Retrieve current information on a single campaign or multiple campaigns.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the campaign is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">organization<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Any organizations associated with the campaign.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Organization ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Organization name.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="campaign-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "campaign",
    "method": "retrieve",
    "id": "JN0Zpj7RGJiwKqAnRoy6"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="campaign-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "Q45jJa6ZjgFYmK5Ek86l",
  "api_call_processed": true,
  "api_call_unix": 1570281688,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "campaign",
  "results": [
    {
      "created_date_unix": 1550530876,
      "description": "Twitter campaign sales and customers.",
      "enabled": true,
      "id": "JN0Zpj7RGJiwKqAnRoy6",
      "name": "Twitter Campaign",
      "organization": [
        {
          "id": "NkEzVWEdV7C9wvKn19Q8",
          "name": "Acme Org"
        }
      ],
      "updated_date_unix": 1551406538
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="chargeback" data-ordernum="4"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text chargeback"><h2>Chargeback</h2><hr></hr><p>A chargeback within RevCent is created either using the API or via a third party integration for credit card transactions within RevCent.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="chargeback-create" data-ordernum="5"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text chargeback-create"><h3>Chargeback Create</h3><hr></hr><p>
        Create a chargeback within RevCent via the chargeback create method. A chargeback is specific to an existing RevCent credit card transaction. Therefore, when creating a chargeback, the transaction_id or gateway_transaction_id for the related transaction must be provided.
        <br><br>
        It is recommended to distinguish the chargebacks by sub type(s), i.e. Verifi, RDR, etc., if applicable, using metadata. Only include metadata entries that are applicable to the chargeback. Examples recognized by RevCent below:
        <br>
        
        <dl class="dl-horizontal">
            <dt>RDR</dt><dd>{
  "name": "is_rdr",
  "value": "true"
}</dd>
            <dt>Verifi</dt><dd>{
  "name": "is_verifi",
  "value": "true"
}</dd>
            <dt>Ethoca</dt><dd>{
  "name": "is_ethoca",
  "value": "true"
}</dd>
            <dt>TC40</dt><dd>{
  "name": "is_tc40",
  "value": "true"
}</dd>
        </dl>
        </p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent transaction ID for the chargeback related transaction. If not present, you must provide the gateway_transaction_id property.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_transaction_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway transaction ID for the chargeback related transaction. Only provide if the transaction_id property is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The chargeback amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">arn<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The acquirer reference number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargeback_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the chargeback created by the issuing bank.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">received_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the chargeback was received.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">case_number<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The chargeback case number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">reason_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The chargeback reason code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent third party integration ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_chargeback_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party chargeback ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_order_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party order ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">void_transaction<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>You can choose to void the transaction, which will automatically issue a full refund. Default is false. Note: This cannot be undone.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">representment<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Representment details related to the chargeback, if a representment has taken place.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">initiated<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether a representment has been initiated. Read-only once set.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">initiated_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the representment was initiated. Read-only once set.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">completed<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the representment has completed, with an outcome. The initiated property must be set, or have been previously set, to true. Read-only once set.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">completed_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the representment was completed, with an outcome. Read-only once set.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">outcome<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The outcome of the chargeback representment. Can be either "pending", "won" or "lost". The initiated and completed properties must be set, or have been previously set, to true.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargeback_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the chargeback.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction ID assigned by the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID associated with the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the credit card transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">void_transaction<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction was simultaneously voided along with the chargeback creation.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="chargeback-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "chargeback",
    "method": "create",
    "transaction_id": "EMO5Xo8qMEf15YXQywkR",
    "gateway_transaction_id": "60157523306",
    "amount": 140,
    "arn": "arn_1",
    "chargeback_date": "12/01/2020",
    "received_date": "12/04/2020",
    "case_number": "1234",
    "reason_code": "4",
    "third_party_chargeback_id": "cb_1",
    "third_party_order_id": "or_1",
    "void_transaction": false,
    "representment": {
      "initiated": true,
      "initiated_date": "12/04/2020"
    },
    "metadata": [
      {
        "name": "is_verifi",
        "value": "true"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="chargeback-create-response" class="highlight-code language-json ">{
  "amount": 21.39,
  "api_call_id": "WmbX7n17zGTL65ZqPnp9",
  "api_call_processed": true,
  "api_call_unix": 1609122150,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "chargeback_id": "j0a9dNwVKqu8Qz5Vl6ZZ",
  "code": 1,
  "customer_id": "2rn1nnqKN6i6wmdKolJE",
  "gateway": "Authorize.net",
  "gateway_id": "LYE26MW8Rlh5VbJmlp2l",
  "gateway_transaction_id": "60158956353",
  "merchant_account_id": "5678",
  "request_method": "create",
  "request_type": "chargeback",
  "result": "Chargeback created.",
  "transaction_id": "gYZVZZbdmRTl7g2aJyNN",
  "void_transaction": false
}</pre></div></div></div></section><section id="chargeback-edit" data-ordernum="6"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text chargeback-edit"><h3>Chargeback Edit</h3><hr></hr><p>Edit an existing chargeback within RevCent via the chargeback edit method.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargeback_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent chargeback ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The chargeback amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">arn<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The acquirer reference number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargeback_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the chargeback created by the issuing bank.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">received_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the chargeback was received.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">case_number<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The chargeback case number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">reason_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The chargeback reason code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent third party integration ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_chargeback_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party chargeback ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_order_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party order ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">representment<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Representment details related to the chargeback, if a representment has taken place.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">initiated<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether a representment has been initiated. Read-only once set.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">initiated_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the representment was initiated. Read-only once set.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">completed<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the representment has completed, with an outcome. The initiated property must be set, or have been previously set, to true. Read-only once set.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">completed_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the representment was completed, with an outcome. Read-only once set.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">outcome<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The outcome of the chargeback representment. Can be either "pending", "won" or "lost". The initiated and completed properties must be set, or have been previously set, to true.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargeback_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the chargeback.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="chargeback-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "chargeback",
    "method": "edit",
    "chargeback_id": "0p9yLjoq91u9wVEqZ2M2",
    "amount": 140,
    "arn": "arn_1",
    "chargeback_date": "10/01/2020",
    "received_date": "10/04/2020",
    "case_number": "1234",
    "reason_code": "4",
    "third_party_chargeback_id": "cb_1",
    "third_party_order_id": "or_1",
    "representment": {
      "completed": true,
      "completed_date": "12/04/2020",
      "outcome": "won"
    },
    "metadata": [
      {
        "name": "is_rdr",
        "value": "true"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="chargeback-edit-response" class="highlight-code language-json ">{
  "api_call_id": "mJLY1aqWOvCJBL4wAqV8",
  "api_call_processed": true,
  "api_call_unix": 1609122072,
  "chargeback_id": "Nk6llENAROsKvm8PLlOw",
  "code": 1,
  "request_method": "edit",
  "request_type": "chargeback",
  "result": "Chargeback edited."
}</pre></div></div></div></section><section id="chargeback-retrieve" data-ordernum="7"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text chargeback-retrieve"><h3>Chargeback Retrieve</h3><hr></hr><p>Retrieve current information on a single chargeback or multiple chargebacks.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the transaction associated with the fraud detection.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">arn<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The acquirer reference number, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">case_number<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The case number, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargeback_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the chargeback occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargeback_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of the date the chargeback occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detections<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing fraud detection IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID associated with the merchant gateway.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction ID assigned by the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_third_party_integration<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the chargeback is associated with a RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID associated with the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">origin_api_call<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The original API call that created the entity associated with the chargeback.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the original API call that created the entity associated with the chargeback.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of the date of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ip_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The IP address that was used to make the API call.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">reason_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The chargeback reason code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">received_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the chargeback was received by you or the third party.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">received_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of the date the chargeback was received by you or the third party.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">representment<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a chargeback has an initiated representment, details on the representment will be provided.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">initiated<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether a representment has been initiated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">initiated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the representment was initiated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">completed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the representment has completed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">completed_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the representment was completed, with an outcome.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">outcome<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The outcome of the chargeback representment. Can be either "pending", "won" or "lost".</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_chargeback_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party chargeback ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the chargeback was created by a third party integration, details will appear here.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of your RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of your RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the specific third party.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the third party.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the third party.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_order_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party order ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific transaction the chargeback is related to.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent transaction ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of the date the transaction was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the transaction was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of the date the transaction was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the transaction was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_account_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_item_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_items<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item IDs related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="chargeback-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "chargeback",
    "method": "retrieve",
    "id": "O04ll4qkllTXqA5Xd79L"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="chargeback-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "5rkZvym5BNIO6WQX9PJl",
  "api_call_processed": true,
  "api_call_unix": 1609120332,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "chargeback",
  "results": [
    {
      "amount": 42.36,
      "arn": "12345",
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "Twitter Campaign",
      "case_number": "56789",
      "chargeback_date": "2020-12-23T05:00:00+00:00",
      "chargeback_date_unix": 1608699600,
      "check_directs": [],
      "created_date_unix": 1608738415,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "fraud_detections": [],
      "gateway": {
        "name": "Authorize.net",
        "id": "LYE26MW8Rlh5VbJmlp2l",
        "merchant_account_id": "12345678"
      },
      "gateway_transaction_id": "60158776104",
      "id": "O04ll4qkllTXqA5Xd79L",
      "invoices": [],
      "is_third_party_integration": false,
      "iso_currency": "USD",
      "live_mode": false,
      "merchant_account_id": "12345678",
      "metadata": [],
      "offline_payments": [],
      "origin_api_call": {
        "id": "RJblXjvvEgsqjGQrBjoX",
        "date": "2020-12-22T23:22:04+00:00",
        "date_unix": 1608679324,
        "type": "subscription",
        "method": "renew",
        "ip_address": "123.456.789.101"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [],
      "reason_code": "2",
      "received_date": "2020-12-23T05:00:00+00:00",
      "received_date_unix": 1608699600,
      "representment": {
        "initiated": true,
        "initiated_date": "2020-12-22T23:22:05+00:00",
        "completed": true,
        "completed_date": "2020-12-25T01:26:18+00:00",
        "outcome": "won"
      },
      "sales": [
        "y2wARbKL8PCPL46Xb7qA"
      ],
      "salvage_transactions": [],
      "shipping": [
        "y2Wrl6kwZoUdBWJjABp0"
      ],
      "status": "Created",
      "subscription_renewals": [
        "zGkXy5Qa0OH4qWAozq58"
      ],
      "tax": [
        "qZM1QVAqwRik6BJNq6vW"
      ],
      "third_party_chargeback_id": "",
      "third_party_integration": null,
      "third_party_order_id": "",
      "transaction": {
        "id": "pgPbQlGpr8fWQ72NbQrB",
        "created_date_unix": 1608679325,
        "created_date": "2020-12-22T23:22:05+00:00",
        "updated_date_unix": 1608859578,
        "updated_date": "2020-12-25T01:26:18+00:00",
        "amount": 42.36
      },
      "transactions": [
        "pgPbQlGpr8fWQ72NbQrB"
      ],
      "trials": [],
      "updated_date_unix": 1608738415,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="coupon" data-ordernum="8"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text coupon"><h2>Coupon</h2><hr></hr><p>A coupon is created within the RevCent web app and can be applied to initial sales, subsequent subscription renewals and future customer purchases based on settings. Create specific rules, expiration dates and discount types within the web app when creating a coupon.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="coupon-validate" data-ordernum="9"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text coupon-validate"><h3>Coupon Validate</h3><hr></hr><p>Validate a coupon using the coupon code. A rejected coupon code will display an error explaining the reason for rejection, while an applicable coupon code will display the discount type and amount.<br><br>To get the actual discount amount for a new sale using a valid coupon, use the <a href="#sale-estimate">sale estimate</a> API request.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon associated with the coupon code.<br><br><strong>If coupon code submitted is invalid, this coupon property will equal null.</strong><br><br>Check for null coupon property in response to validate coupon code.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the coupon is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon start date.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon end date.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon discount type, either percent or amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon discount value relative to the discount type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_use<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of times the coupon was used in a successful sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon profile associated with the coupon.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the coupon profile is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_use_max<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether there is a maximum use limit within the coupon profile associated with the coupon.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the coupon code is valid. If invalid (coupon = null) the reason for the coupon code being invalid.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="coupon-validate-request" class="highlight-code language-json ">{
  "request": {
    "type": "coupon",
    "method": "validate",
    "coupon_code": "10percent"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="coupon-validate-response" class="highlight-code language-json ">{
  "api_call_id": "qZBoPgKB0lIOJG6LJZ4R",
  "api_call_processed": true,
  "api_call_unix": 1570459361,
  "code": 1,
  "coupon": {
    "id": "VPmmrpbVl7cQ9JaXEanl",
    "coupon_code": "10percent",
    "enabled": true,
    "start_date_unix": 1567559820,
    "end_date_unix": 1580446800,
    "discount_type": "percent",
    "discount_value": 10,
    "num_use": 66,
    "coupon_profile": {
      "id": "k6vvXQwwNycvJM7yMwzL",
      "enabled": true,
      "num_use_max": 0
    }
  },
  "request_method": "validate",
  "request_type": "coupon",
  "result": "Valid"
}</pre></div></div></div></section><section id="customer" data-ordernum="10"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer"><h2>Customer</h2><hr></hr><p>A customer is an individual that is created either by sale, signup, etc. Every customer is given a unique ID as well as the ability to add multiple credit cards.<br><br>Implement metadata when creating a sale or customer for enhanced analytics. Our TrackJS feature is extremely useful for tracking visitors and linking them to new customers. We highly recommend you implement metadata as well as TrackJS to know more about your customers.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="customer-create" data-ordernum="11"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-create"><h3>Customer Create</h3><hr></hr><p>Create a customer via the customer create method. Useful for signup or prospect purposes where a sale has yet to take place.</p><div class="alert alert-default"><p><strong>AdWords Integration</strong></p><p>If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID. Read more about integrating AdWords with RevCent on our <a href="https://kb.revcent.com/en/tracking/google-adwords" target="_blank">Knowledge Base <i class="far fa-external-link-square-alt small"></i></a>. </p><p><i>Example</i></p><pre>"metadata":[{"name": "adwords_click", "value": "ADWORDS_CLICK_ID_HERE"}]</pre></div><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object receives first priority as details if creating a new customer.<br><br>If the customer object is not present the bill_to and ship_to objects will be used in the respective order.<br><br>If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.<br><br>This does not apply if using a customer_id field in the request where applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bill_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the billing information. If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to add a payment method with the customer upon creation.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">credit_card<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">card_number<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card number. This value must be a valid credit card number as a string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_month<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month. Two digit integer, MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_year<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year. Two digit integer, YY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card code as a string. Depending on the card type this can be different lengths.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">set_as_default<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The email address of the related customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The first name of the related customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last name of the related customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "create",
    "campaign": "Twitter Campaign",
    "customer": {
      "first_name": "udhi",
      "last_name": "pguolnvc",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ndjo@gmail.com",
      "phone": "1234567890"
    },
    "bill_to": {
      "first_name": "udhi",
      "last_name": "pguolnvc",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ndjo@gmail.com",
      "phone": "1234567890"
    },
    "internal_customer_id": "cus_7791",
    "payment": {
      "credit_card": {
        "card_number": "4242424242424242",
        "exp_month": 12,
        "exp_year": 20,
        "card_code": "999"
      }
    },
    "metadata": [
      {
        "name": "adwords_click",
        "value": "Cjat0KwhCQjdTq..."
      },
      {
        "name": "sign_up_page",
        "value": "v1"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-create-response" class="highlight-code language-json ">{
  "api_call_id": "Nk5voyYVvgTOJkEdGRyj",
  "api_call_processed": true,
  "api_call_unix": 1565814918,
  "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
  "campaign_name": "Twitter Campaign",
  "card_id": "YaVqjAZNqzCGvrrZgGqm",
  "code": 1,
  "customer_email": "ndjo@gmail.com",
  "customer_first_name": "udhi",
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "customer_last_name": "pguolnvc",
  "request_method": "create",
  "request_type": "customer",
  "result": "Created new customer and added card."
}</pre></div></div></div></section><section id="customer-edit" data-ordernum="12"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-edit"><h3>Customer Edit</h3><hr></hr><p>Edit customer information.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object receives first priority as details if creating a new customer.<br><br>If the customer object is not present the bill_to and ship_to objects will be used in the respective order.<br><br>If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.<br><br>This does not apply if using a customer_id field in the request where applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal customer ID.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "edit",
    "customer_id": "mJGAbQ0zAmU12rpngR1M",
    "customer": {
      "first_name": "ywbw",
      "last_name": "fbjdbefa",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "izlo@gmail.com",
      "phone": "1234567890"
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-edit-response" class="highlight-code language-json ">{
  "api_call_id": "P65Gn2z6WMs552lNYg6q",
  "api_call_processed": true,
  "api_call_unix": 1565814919,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "edit",
  "request_type": "customer",
  "result": "Customer information successfully edited."
}</pre></div></div></div></section><section id="customer-enable" data-ordernum="13"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-enable"><h3>Customer Enable</h3><hr></hr><p>Enabled a customer that was previously disabled.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer ID</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-enable-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "enable",
    "customer_id": "mJGAbQ0zAmU12rpngR1M"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-enable-response" class="highlight-code language-json ">{
  "api_call_id": "BvwOyAQgd8u226OMrOqY",
  "api_call_processed": true,
  "api_call_unix": 1565814920,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "enable",
  "request_type": "customer",
  "result": "Customer enabled."
}</pre></div></div></div></section><section id="customer-disable" data-ordernum="14"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-disable"><h3>Customer Disable</h3><hr></hr><p>Disable a customer, preventing future purchases.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer ID</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-disable-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "disable",
    "customer_id": "mJGAbQ0zAmU12rpngR1M"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-disable-response" class="highlight-code language-json ">{
  "api_call_id": "ZVEGoyPVA0fZJMPo8Kav",
  "api_call_processed": true,
  "api_call_unix": 1565814919,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "disable",
  "request_type": "customer",
  "result": "Customer disabled."
}</pre></div></div></div></section><section id="customer-add-card" data-ordernum="15"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-add-card"><h3>Customer Add Card</h3><hr></hr><p>Add a credit card to a customer, with the ability to set the card as default.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bill_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the billing information. If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object containing the credit card you wish to add.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">credit_card<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">card_number<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card number. This value must be a valid credit card number as a string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_month<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month. Two digit integer, MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_year<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year. Two digit integer, YY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card code as a string. Depending on the card type this can be different lengths.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">set_as_default<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-add-card-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "add_card",
    "customer_id": "mJGAbQ0zAmU12rpngR1M",
    "bill_to": {
      "first_name": "orhw",
      "last_name": "selldjxk",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "utnl@gmail.com",
      "phone": "1234567890"
    },
    "payment": {
      "credit_card": {
        "card_number": "4141414141414141",
        "exp_month": 10,
        "exp_year": 23,
        "card_code": "123",
        "set_as_default": true
      }
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-add-card-response" class="highlight-code language-json ">{
  "api_call_id": "j0LNQJG1B7UggmXw950J",
  "api_call_processed": true,
  "api_call_unix": 1565814920,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "add_card",
  "request_type": "customer",
  "result": "Customer card added."
}</pre></div></div></div></section><section id="customer-add-to-group" data-ordernum="16"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-add-to-group"><h3>Customer Add To Group</h3><hr></hr><p>Add a customer to a customer group.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_group<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of one or more Customer Group IDs.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-add-to-group-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "add_to_group",
    "customer_id": "LY9BAEgLymHObBR7GKdw",
    "customer_group": [
      "8rRGOVwwNLTaawApmQv8"
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-add-to-group-response" class="highlight-code language-json ">{
  "api_call_id": "ZVEGoyPVA0fZJMPo8Kav",
  "api_call_processed": true,
  "api_call_unix": 1565814919,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "add_to_group",
  "request_type": "customer",
  "result": "Customer added to group(s)."
}</pre></div></div></div></section><section id="customer-remove-from-group" data-ordernum="17"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-remove-from-group"><h3>Customer Remove From Group</h3><hr></hr><p>Remove a customer from a customer group.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_group<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of one or more Customer Group IDs.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-remove-from-group-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "remove_from_group",
    "customer_id": "LY9BAEgLymHObBR7GKdw",
    "customer_group": [
      "8rRGOVwwNLTaawApmQv8"
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-remove-from-group-response" class="highlight-code language-json ">{
  "api_call_id": "ZVEGoyPVA0fZJMPo8Kav",
  "api_call_processed": true,
  "api_call_unix": 1565814919,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "remove_from_group",
  "request_type": "customer",
  "result": "Customer removed from group(s)."
}</pre></div></div></div></section><section id="customer-retrieve" data-ordernum="18"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-retrieve"><h3>Customer Retrieve</h3><hr></hr><p>Retrieve current information on a single customer or multiple customers. You can use either the RevCent ID or email address for retrieving a single customer.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer. Required if multiple property equals false and email property not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The email address of the customer. Required if multiple property equals false and id property not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">anonymous<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer was created without identifiable information.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_calls<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing api call IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been marked as blocked, preventing the customer from making purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargebacks<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing chargeback IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of customer card objects, each being a customer card associated with the customer.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card type, i.e. visa, mastercard, etc.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_4<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last 4 digits of the customer credit card.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration date, formatted MM/YY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_month<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month, formatted MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_year<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year, formatted YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_default<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the credit card is the customers' default card.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_group<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of customer group objects, each being a customer group the customer is associated with.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_group_blocked<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of customer group objects, each being a customer group the customer is blocked from being associated with.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is enabled and available to purchase and make payments.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_requests<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing fraud detection request IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detections<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing fraud detection IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>True if customer address was submitted and geocoding was successful, otherwise false.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Google place ID of customer if successfully geocoded</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Geocode latitude of customer if successfully geocoded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">license_keys<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of RevCent license key ID's associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lifetime_value<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Overall lifetime values for the customer.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">all<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The combined total of sale and subscription renewal value types.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount discounted for all sales and renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount gross for all sales and renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount net for all sales and renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount refunded for all sales and renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount remaining for all sales and renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount to salvage for all sales and renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum total volume for all sales and renewals.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sale value type, specific to the customers' sales.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount discounted for all sales.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount gross for all sales.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount net for all sales.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount refunded for all sales.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount remaining for all sales.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount to salvage for all sales.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum total volume for all sales.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of sales.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">avg<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The average sale amount gross.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewal<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The subscription renewal value type, specific to the customers' subscription renewals.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount discounted for all subscription renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount gross for all subscription renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount net for all subscription renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount refunded for all subscription renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount remaining for all subscription renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum amount to salvage for all subscription renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sum total volume for all subscription renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of subscription renewals regardless of status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">avg<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The average subscription renewal amount gross.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_overdue<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of subscription renewals with a status of Overdue.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fraud detection value type, specific to the customers' fraud detections.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of all fraud detections.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of fraud detections.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">avg<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The average fraud detection amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargeback<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The chargeback value type, specific to the customers' chargebacks.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of all chargebacks.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of chargebacks.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">avg<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The average chargeback amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The pending refund value type, specific to the customers' pending refunds.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of refunds issued to the customer.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_sale_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date of the last sale for the customer, if available.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_subscription_renewal_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date of the last subscription renewal for the customer, if available.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Geocode longitude of customer if successfully geocoded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products_purchased<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The products the customer has purchased over their lifetime.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product internal ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product SKU.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total quantity for all purchases of this product by the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The average price for all purchases of this product by the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount gross specific to the product for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount refunded specific to the product for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">purchase_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of separate purchases of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">purchase_dates<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The individual dates, as a unix timestamp, of each purchase.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quota_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing quota account IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "retrieve",
    "id": "ajOAl24bBXc5nXwagAOg"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "X8681XdaPpfrmYgyaVAp",
  "api_call_processed": true,
  "api_call_unix": 1641919241,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "customer",
  "results": [
    {
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "anonymous": false,
      "api_calls": [
        "vEP9QdWngpUrNGW6llkv"
      ],
      "blocked": false,
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "AdWords Campaign",
      "chargebacks": [],
      "check_directs": [],
      "city": "Washington",
      "company": "",
      "country": "USA",
      "created_date_unix": 1641564098,
      "customer_card": [
        {
          "created_date_unix": 1641564098,
          "updated_date_unix": 1641746186,
          "id": "ALAGkvj0O7u5rdmVggQ7",
          "type": "visa",
          "last_4": "1111",
          "expiry_date": "11/23",
          "expiry_month": "11",
          "expiry_year": "2023",
          "is_default": true
        }
      ],
      "customer_group": [
        {
          "id": "2rRMqP5nojF6EgJqwQVL",
          "name": "My Customer Group"
        }
      ],
      "customer_group_blocked": [],
      "discounts": [],
      "email": "georgew@whitehouse.com",
      "enabled": true,
      "first_name": "George",
      "fraud_detection_requests": [],
      "fraud_detections": [],
      "full_address": "1600 Pennsylvania Ave, Washington, DC 20500, USA",
      "geocode_success": true,
      "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
      "id": "O0O0LON20nTaNQ6gg6Lm",
      "internal_id": "pres_0001",
      "invoices": [],
      "last_name": "Washington",
      "lat": "32.5614023",
      "license_keys": [],
      "lifetime_value": {
        "all": {
          "amount_discounted": 0,
          "amount_gross": 363.55,
          "amount_net": 355.55,
          "amount_refunded": 0,
          "amount_remaining": 23.75,
          "amount_to_salvage": 23.75,
          "amount_total": 387.3
        },
        "sale": {
          "amount_discounted": 0,
          "amount_gross": 363.55,
          "amount_net": 355.55,
          "amount_refunded": 0,
          "amount_remaining": 23.75,
          "amount_to_salvage": 23.75,
          "amount_total": 387.3,
          "num": 1,
          "avg": 363.55
        },
        "subscription_renewal": {
          "amount_discounted": 0,
          "amount_gross": 0,
          "amount_net": 0,
          "amount_refunded": 0,
          "amount_remaining": 0,
          "amount_to_salvage": 0,
          "amount_total": 0,
          "num": 0,
          "avg": 0,
          "num_overdue": 0
        },
        "fraud_detection": {
          "amount": 0,
          "num": 0,
          "avg": 0
        },
        "chargeback": {
          "amount": 0,
          "num": 0,
          "avg": 0
        },
        "pending_refund": {
          "num": 0
        },
        "last_sale_date": "2022-01-07T14:01:38.458Z",
        "last_subscription_renewal_date": null
      },
      "lon": "-90.19291299999999",
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [
        {
          "created_date": "2022-01-10T14:35:21+00:00",
          "created_date_unix": 1641825321,
          "updated_date": "2022-01-10T14:35:21+00:00",
          "updated_date_unix": 1641825321,
          "id": "9r0NrKQ864FaOrmOYmQn",
          "text": "Example customer note.",
          "username": "JohnDoe",
          "first_name": "John",
          "last_name": "Doe",
          "employee_id": "mWwZ8KyrOLNOOdbbdUbQ",
          "customer_note_related_type": "customer",
          "customer_note_related_id": "O0O0LON20nTaNQ6gg6Lm"
        }
      ],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "phone": "12345678901",
      "product_sales": [
        "LYG04QV82NHqzpQvLL8m"
      ],
      "products_purchased": [
        {
          "id": "6r8O5MLbw2t6n4v1lGqK",
          "name": "AV 2017",
          "internal_id": "av_2017",
          "sku": "av_2017_sku",
          "quantity": 1,
          "price": 29.99,
          "amount_gross": 28.74,
          "amount_refunded": 0,
          "purchase_count": 1,
          "purchase_dates": [
            1673880787
          ]
        }
      ],
      "quota_accounts": [],
      "sales": [
        "6rYKpkEgmyfBaGONMMVm"
      ],
      "salvage_transactions": [
        "8rkZpLd09Rf2wzVO77W5"
      ],
      "shipping": [
        "l4jWlR78X5cAvvvbnlWJ"
      ],
      "smtp_messages": [],
      "state": "DC",
      "state_long": "DC",
      "status": "Enabled",
      "subscription_renewals": [],
      "subscriptions": [
        "5rnXp2wYjRf9OzWdgg8M"
      ],
      "tax": [
        "rmYb7ro28XTvmmmVE2RA"
      ],
      "transactions": [
        "ZVJZkL6Kn4Cb555PnKP9"
      ],
      "trials": [
        "JNvWwanZLBi8RN1ynnQR"
      ],
      "updated_date_unix": 1641825321,
      "zip": "20500"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="customer-search" data-ordernum="19"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-search"><h3>Customer Search</h3><hr></hr><p>Search for a customer using a string or group of strings.<br> Please read more about <a href="https://kb.revcent.com/en/integrations/revcent-api/api-search" target="_blank">API Search <i class="far fa-external-link-square-alt small"></i></a> before proceeding.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">search_term<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The string to search.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">item_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ip_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fingerprint<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">highlights<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">field<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">values<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">score<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-search-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer",
    "method": "search",
    "search_term": "xbim32@gmail.com"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-search-response" class="highlight-code language-json ">{
  "api_call_id": "MWazbqOmazHZ5QnERONV",
  "api_call_processed": true,
  "api_call_unix": 1681160039,
  "code": 1,
  "request_type": "customer",
  "request_method": "search",
  "results": [
    {
      "item_type": "customer",
      "id": "gYQYYJlMXYHXXL709WlR",
      "created_date_unix": 1680909458,
      "first_name": "George",
      "last_name": "Washington",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "email": "xbim32@gmail.com",
      "phone": "1234567890",
      "internal_id": "",
      "ip_address": "123.456.789.0",
      "enabled": true,
      "fingerprint": "5c8b317a4bb7c91b4ade5ffc357cb6ce",
      "metadata": [],
      "url": "https://revcent.com/user/customer-details/gYQYYJlMXYHXXL709WlR",
      "highlights": [
        {
          "field": "email",
          "values": [
            "xbim32@gmail.com"
          ]
        }
      ],
      "score": 7.68
    }
  ]
}</pre></div></div></div></section><section id="customer-card" data-ordernum="20"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-card"><h2>Customer Card</h2><hr></hr><p>A customer card is specific to a customer, and is either created automatically during an initial sale, or manually added to a customer via web app or API.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="customer-card-add" data-ordernum="21"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-card-add"><h3>Customer Card Add</h3><hr></hr><p>To add a customer card, use the <a href="#customer-add-card">customer > add_card</a> API method instead. This ensures a new card is assigned to the correct customer.<br><br>If the customer does not already exist, use the <a href="#customer-create">customer > create</a> API method and include the credit card details in the request.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="customer-card-enable" data-ordernum="22"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-card-enable"><h3>Customer Card Enable</h3><hr></hr><p>Enable a customer card that was previously disabled.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent customer card ID.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-card-enable-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer_card",
    "method": "enable",
    "customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-card-enable-response" class="highlight-code language-json ">{
  "api_call_id": "9r0rPLQOPATL4zXVVXrZ",
  "api_call_processed": true,
  "api_call_unix": 1641910649,
  "code": 1,
  "customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
  "customer_id": "2rBrjB5arLtoVnPKKPMw",
  "request_method": "enable",
  "request_type": "customer_card",
  "result": "Customer card set to enabled."
}</pre></div></div></div></section><section id="customer-card-disable" data-ordernum="23"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-card-disable"><h3>Customer Card Disable</h3><hr></hr><p>Disable a customer card, preventing its use.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent customer card ID.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-card-disable-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer_card",
    "method": "disable",
    "customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-card-disable-response" class="highlight-code language-json ">{
  "api_call_id": "LYGYa9Nv7kCzL4RPPRoa",
  "api_call_processed": true,
  "api_call_unix": 1641910714,
  "code": 1,
  "customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
  "customer_id": "2rBrjB5arLtoVnPKKPMw",
  "request_method": "disable",
  "request_type": "customer_card",
  "result": "Customer card set to disabled."
}</pre></div></div></div></section><section id="customer-card-delete" data-ordernum="24"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-card-delete"><h3>Customer Card Delete</h3><hr></hr><p>Delete a customer card, removing it from the system. This is irreversible.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent customer card ID.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-card-delete-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer_card",
    "method": "delete",
    "customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-card-delete-response" class="highlight-code language-json ">{
  "api_call_id": "ll2nVEywp2M8Mbr2vXnf",
  "api_call_processed": true,
  "api_call_unix": 1641910772,
  "code": 1,
  "customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
  "customer_id": "2rBrjB5arLtoVnPKKPMw",
  "request_method": "delete",
  "request_type": "customer_card",
  "result": "Customer card deleted."
}</pre></div></div></div></section><section id="customer-card-set-default" data-ordernum="25"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-card-set-default"><h3>Customer Card Set Default</h3><hr></hr><p>Set a customer card as the default card for the customer.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent customer card ID.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-card-set-default-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer_card",
    "method": "set_default",
    "customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-card-set-default-response" class="highlight-code language-json ">{
  "api_call_id": "EM8Mbr2vXnfywp2ll2nV",
  "api_call_processed": true,
  "api_call_unix": 1641910772,
  "code": 1,
  "customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
  "customer_id": "2rBrjB5arLtoVnPKKPMw",
  "request_method": "set_default",
  "request_type": "customer_card",
  "result": "Customer card set as default."
}</pre></div></div></div></section><section id="customer-card-retrieve" data-ordernum="26"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text customer-card-retrieve"><h3>Customer Card Retrieve</h3><hr></hr><p>Retrieve current information on a single customer card or multiple customer cards. To view all cards for a specific customer, simply use the <a href="#customer-retrieve">customer > retrieve</a> method, using the customer ID, which will contain the customers' cards in the response.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The expiration date of the customer card formatted M/YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The expiration date of the customer card formatted MM/YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_month<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The expiration date of the customer card formatted MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_year<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The expiration year of the customer card formatted YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_6<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The first 6 digits of the customer card number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_default<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the card is the customers' default card.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_4<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last 4 digits of the customer card number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card type. I.e. visa, mastercard, etc.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="customer-card-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "customer_card",
    "method": "retrieve",
    "id": "O0O0LON20nTaNQ6gg6Lm"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="customer-card-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "Wm0m9Y2K5YuXrgdvmMAL",
  "api_call_processed": true,
  "api_call_unix": 1641910867,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "customer_card",
  "results": [
    {
      "created_date_unix": 1641910298,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "enabled": false,
      "expiry_date": "11/2023",
      "expiry_month": "11",
      "expiry_year": "2023",
      "first_6": "424242",
      "id": "O0O0LON20nTaNQ6gg6Lm",
      "is_default": true,
      "last_4": "4242",
      "live_mode": false,
      "type": "visa",
      "updated_date_unix": 1641910714
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="discount" data-ordernum="27"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text discount"><h2>Discount</h2><hr></hr><p>A discount is created when RevCent receives a static discount entry or a coupon code during a request.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="discount-retrieve" data-ordernum="28"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text discount-retrieve"><h3>Discount Retrieve</h3><hr></hr><p>Retrieve current information on a single discount or multiple discounts.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The details of any coupon related to the discount.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total discount amount applied.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_percent<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The percentage of total request amount before discount is applied.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type corresponds to discount amount. Default is amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="discount-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "discount",
    "method": "retrieve",
    "id": "5r1wN8EbAgsPvLlbMava"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="discount-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "ZVE5YRjd7RsXZpVw4krG",
  "api_call_processed": true,
  "api_call_unix": 1566160507,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "discount",
  "results": [
    {
      "check_directs": [],
      "coupon": {
        "id": "VPmmrpbVl7cQ9JaXEanl",
        "name": "test2",
        "description": "",
        "coupon_code": "10percent"
      },
      "created_date_unix": 1565965034,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "description": "$5 Off Coupon from facebook link.",
      "discount_amount": 5,
      "discount_percent": 4.17,
      "discount_type": "amount",
      "id": "5r1wN8EbAgsPvLlbMava",
      "name": "$5 Off Coupon",
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [],
      "sales": [
        "Kn5aKb8lQZfXMl0NGjRZ"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1565965035
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="fraud" data-ordernum="29"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud"><h1>Fraud</h1><hr></hr><p>RevCent fraud alerts, fraud detections and fraud detection requests, using manual or third party integrations. Please read carefully about the difference between a fraud alert and a fraud detection.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="fraud-alert" data-ordernum="30"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-alert"><h2>Fraud Alert</h2><hr></hr><p>A fraud alert is simply an <strong>indicator</strong> that a sale may or may not be fraud and needs manual review. An alert can be removed if the sale is determined to not be fraud.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="fraud-alert-add" data-ordernum="31"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-alert-add"><h3>Fraud Alert Add</h3><hr></hr><p>Mark a sale with a fraud alert.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud-alert_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="fraud-alert-add-request" class="highlight-code language-json ">{
  "request": {
    "type": "fraud_alert",
    "method": "add",
    "sale_id": "2rnYMVFGraRJBnPpgvQV"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="fraud-alert-add-response" class="highlight-code language-json ">{
  "api_call_id": "y2WG1ApMMKhW6ZoBb72o",
  "api_call_processed": true,
  "api_call_unix": 1609086154,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "9rZ68zWWglFY8O26azRX",
  "request_method": "add",
  "request_type": "fraud_alert",
  "result": "Fraud alert added to sale.",
  "sale_id": "2rnYMVFGraRJBnPpgvQV"
}</pre></div></div></div></section><section id="fraud-alert-remove" data-ordernum="32"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-alert-remove"><h3>Fraud Alert Remove</h3><hr></hr><p>Remove an existing fraud alert from a sale.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud-alert_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="fraud-alert-remove-request" class="highlight-code language-json ">{
  "request": {
    "type": "fraud_alert",
    "method": "remove",
    "sale_id": "2rnYMVFGraRJBnPpgvQV"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="fraud-alert-remove-response" class="highlight-code language-json ">{
  "api_call_id": "qZM6vXNEVasgj0XVJO50",
  "api_call_processed": true,
  "api_call_unix": 1609118598,
  "code": 1,
  "customer_id": "9rZ68zWWglFY8O26azRX",
  "request_method": "remove",
  "request_type": "fraud_alert",
  "result": "Fraud alert removed from sale.",
  "sale_id": "2rnYMVFGraRJBnPpgvQV"
}</pre></div></div></div></section><section id="fraud-detection" data-ordernum="33"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-detection"><h2>Fraud Detection</h2><hr></hr><p>A fraud detection is <strong>confirmation</strong> that an item is indeed fraud. Once created it cannot be removed or un-done. You can create a fraud detection using either the API, or via a third party integration, for credit card, PayPal, checks or offline payments.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="fraud-detection-create" data-ordernum="34"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-detection-create"><h3>Fraud Detection Create</h3><hr></hr><p>Create a fraud detection within RevCent via the fraud detection create method.<br><br><strong>Important</strong>: A fraud detection must have an originating RevCent API call, which RevCent will find when you provide a value for <i>source_id</i>. The value for the <i>source_id</i> property can be from one of the items listed below.<br><dl class="dl-horizontal"><dt>API Call ID<dt><dd>The RevCent ID for the originating API call.</dd><dt>Sale ID<dt><dd>The RevCent ID for a sale.</dd><dt>Transaction ID<dt><dd>The RevCent ID for a credit card transaction.</dd><dt>Gateway Transaction ID<dt><dd>The payment gateways' ID for a credit card transaction.</dd><dt>PayPal Transaction ID<dt><dd>The RevCent ID or PayPal ID for a PayPal transaction.</dd><dt>Check ID<dt><dd>The RevCent ID for a check payment.</dd><dt>Offline Payment ID<dt><dd>The RevCent ID for an offline payment.</dd><dt>Customer ID<dt><dd>The RevCent ID for a customer. Only use when a customer is without a sale or payment attempt, i.e. prospect.</dd></dl></p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source ID. Read the important information above.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">void_sale<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>You can choose to automatically void the sale, by setting to true, if source_id is a RevCent sale ID. Default is false. Note: This will fully refund all entities of the sale and cannot be undone.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">flag_similar_sale<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>You can choose to have RevCent add fraud alerts to similar sales. Default is false.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">arn<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The acquirer reference number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">event_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date of the fraud event.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the fraud was detected.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">case_number<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The case number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent third party integration ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_fraud_detection_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party fraud detection ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_order_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party order ID.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent IDs of each fraud detection created as a result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">origin_api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the original API call that created the entity associated with the fraud.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">void_sale<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the sale was simultaneously voided along with the fraud detection creation.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="fraud-detection-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "fraud_detection",
    "method": "create",
    "source_id": "2rnYMVFGraRJBnPpgvQV",
    "void_sale": false,
    "flag_similar_sale": false,
    "arn": "93994",
    "event_date": "12/01/2020",
    "fraud_detection_date": "12/11/2020",
    "case_number": "4999",
    "third_party_integration_id": "8r4lFWLbEr1PZglb7d8z",
    "third_party_fraud_detection_id": "123456",
    "third_party_order_id": "00001",
    "metadata": [
      {
        "name": "fraud",
        "value": "12345"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="fraud-detection-create-response" class="highlight-code language-json ">{
  "api_call_id": "y2WG1ApMMKhW6ZoBb72o",
  "api_call_processed": true,
  "api_call_unix": 1609086154,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "9rZ68zWWglFY8O26azRX",
  "fraud_detection_created": [
    "VPwOydX2ArHJy8gX2o98"
  ],
  "origin_api_call_id": "O04EbzqqdltXb7EOGQpz",
  "request_method": "create",
  "request_type": "fraud_detection",
  "result": "Fraud detection created.",
  "void_sale": false
}</pre></div></div></div></section><section id="fraud-detection-edit" data-ordernum="35"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-detection-edit"><h3>Fraud Detection Edit</h3><hr></hr><p>Edit an existing fraud detection within RevCent via the fraud detection edit method.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the fraud detection.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the related transaction associated with the fraud detection.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">arn<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The acquirer reference number, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">event_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date of the fraud event.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the fraud was detected.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">case_number<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The case number, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">false_positive<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the fraud detection is incorrect. I.e. The related payment is not actually fraud.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent third party integration ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_fraud_detection_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party fraud detection ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_order_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party order ID.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the fraud detection.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="fraud-detection-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "fraud_detection",
    "method": "edit",
    "fraud_detection_id": "LYklEVoPJLfq65rR290A",
    "amount": 140,
    "arn": "93995",
    "event_date": "12/29/2020",
    "fraud_detection_date": "12/30/2020",
    "case_number": "5000",
    "false_positive": true,
    "third_party_integration_id": "8r4lFWLbEr1PZglb7d8z",
    "third_party_fraud_detection_id": "7890",
    "third_party_order_id": "00002"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="fraud-detection-edit-response" class="highlight-code language-json ">{
  "api_call_id": "qZM6vXNEVasgj0XVJO50",
  "api_call_processed": true,
  "api_call_unix": 1609118598,
  "code": 1,
  "fraud_detection_id": "LYklEVoPJLfq65rR290A",
  "request_method": "edit",
  "request_type": "fraud_detection",
  "result": "Fraud detection edited."
}</pre></div></div></div></section><section id="fraud-detection-retrieve" data-ordernum="36"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-detection-retrieve"><h3>Fraud Detection Retrieve</h3><hr></hr><p>Retrieve current information on a single fraud detection or multiple fraud detections.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the transaction associated with the fraud detection.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">arn<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The acquirer reference number, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">case_number<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The case number, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargebacks<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing chargeback IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">event_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date of the fraud event.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">event_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of the date of the fraud event.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">false_positive<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the fraud detection is incorrect. I.e. The related payment is not actually fraud.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the fraud was detected.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of the date the fraud was detected.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_requests<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing fraud detection request IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_third_party_integration<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the fraud detection is associated with a RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">origin_api_call<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The original API call that created the entity associated with the fraud detection.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the original API call that created the entity associated with the fraud.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of the date of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ip_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The IP address that was used to make the API call.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revcent_shop<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted shopping cart that item originated from.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_fraud_detection_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party fraud detection ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the fraud detection was created by a third party integration, details will appear here.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of your RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of your RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the specific third party.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the third party.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the third party.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_order_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party order ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party shop related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_account_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_item_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_items<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item IDs related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="fraud-detection-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "fraud_detection",
    "method": "retrieve",
    "id": "d9bmzA9lr8tYJAyLkBZO"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="fraud-detection-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "BvGBOZ2k14cXbZ1AvE17",
  "api_call_processed": true,
  "api_call_unix": 1609092655,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "fraud_detection",
  "results": [
    {
      "amount": 21.61,
      "arn": "arn234",
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "case_number": "fraud123",
      "chargebacks": [],
      "check_directs": [],
      "created_date_unix": 1609086154,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "details_response": "{}",
      "discounts": [],
      "event_date": "2020-12-01T00:00:00+00:00",
      "event_date_unix": 1606780800,
      "false_positive": false,
      "fraud_detection_date": "2020-12-11T00:00:00+00:00",
      "fraud_detection_date_unix": 1607644800,
      "fraud_detection_requests": [],
      "id": "VPwOydX2ArHJy8gX2o98",
      "invoices": [],
      "is_third_party_integration": true,
      "iso_currency": "USD",
      "license_keys": [],
      "live_mode": false,
      "metadata": [
        {
          "name": "fraud",
          "value": "12345",
          "entry_date": "2020-12-27"
        }
      ],
      "notes": [],
      "offline_payments": [],
      "origin_api_call": {
        "id": "O04EbzqqdltXb7EOGQpz",
        "date": "2020-12-27T16:20:24+00:00",
        "date_unix": 1609086024,
        "type": "sale",
        "method": "create",
        "ip_address": "123.456.789.101"
      },
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "zGkMgj2aKPhWBbNqdGjG"
      ],
      "quota_accounts": [],
      "revcent_shop": null,
      "sale_id": "BvGqjz00dlT2jEk65OnW",
      "sales": [
        "BvGqjz00dlT2jEk65OnW"
      ],
      "salvage_transactions": [],
      "shipping": [
        "d9bgVWPpEvFwBW29R8jP"
      ],
      "smtp_messages": [],
      "status": "Created",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [
        "pgPZnmRpYkf710aQ8jRA"
      ],
      "third_party_fraud_detection_id": "third_party_id123",
      "third_party_integration": {
        "id": "8r4Er1PZglFWLblb7d8z",
        "name": "Midigator Prevention",
        "third_party": {
          "id": "zGkz8XvX9yT48q6LRqjW",
          "name": "Midigator Prevention"
        }
      },
      "third_party_order_id": "third_party_order_id4342",
      "third_party_shop": null,
      "transactions": [
        "2rnPpgvYMVFGraRJBnQV"
      ],
      "trials": [],
      "updated_date_unix": 1609086154,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_entries": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="fraud-detection-request" data-ordernum="37"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-detection-request"><h2>Fraud Detection Request</h2><hr></hr><p>A fraud detection request within RevCent is created when RevCent contacts a third party integration and requests information on a payment before the payment is processed.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="fraud-detection-request-retrieve" data-ordernum="38"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text fraud-detection-request-retrieve"><h3>Fraud Detection Request Retrieve</h3><hr></hr><p>Retrieve current information on a single fraud detection request or multiple fraud detection requests.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">chargebacks<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing chargeback IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detections<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing fraud detection IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">integration_mode<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party integration mode, i.e. live or test.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_error<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the request resulted in an error.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_fraud_detected<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the fraud detection request resulted in a fraud detection.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_payment_allowed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>When the fraud detection request allowed the source payment to be processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_third_party_integration<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the request was sent to a third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">license_keys<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of RevCent license key ID's associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quota_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing quota account IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The raw response returned from the third party when originally contacted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revcent_shop<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted shopping cart that item originated from.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_fraud_detection_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party ID for the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Third party integration.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of your RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of your RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the specific third party.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the third party.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the third party.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party shop related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_account_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_item_entries<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item entry IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_item_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_items<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item IDs related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="fraud-detection-request-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "fraud_detection_request",
    "method": "retrieve",
    "id": "RJ8a2blwBlFbbwPppNZA"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="fraud-detection-request-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "j08r887w1ahVE88gl0z5",
  "api_call_processed": true,
  "api_call_unix": 1611257424,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "fraud_detection_request",
  "results": [
    {
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "chargebacks": [],
      "check_directs": [],
      "created_date_unix": 1611181895,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "fraud_detections": [],
      "id": "RJ8a2blwBlFbbwPppNZA",
      "integration_mode": "Test",
      "invoices": [],
      "is_error": false,
      "is_fraud_detected": false,
      "is_payment_allowed": true,
      "is_third_party_integration": true,
      "iso_currency": "USD",
      "license_keys": [],
      "live_mode": false,
      "metadata": [
        {
          "name": "kount_session_id",
          "value": "c8ed4debf8f242be972c1071731052e8",
          "entry_date": "2021-01-20"
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "Wmv2Bb1nOdu55kl22JKV"
      ],
      "quota_accounts": [],
      "raw_response": "",
      "revcent_shop": null,
      "sale_id": "Nk4OV6Wdm5INNEPXXVr7",
      "sales": [
        "Nk4OV6Wdm5INNEPXXVr7"
      ],
      "salvage_transactions": [],
      "shipping": [
        "0pKAO9JoNYFrrNall7Xp"
      ],
      "smtp_messages": [],
      "status": "Success",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [
        "k6a8rV2nw9FLLO9GGXvy"
      ],
      "third_party_fraud_detection_id": "DWKW0YW258ZM",
      "third_party_integration": {
        "id": "ajYRoLokyXf62qy06JpZ",
        "name": "Kount Risk Inquiry",
        "third_party": {
          "id": "mJEZdyVavzUL0gGoLR1Z",
          "name": "Kount"
        }
      },
      "third_party_shop": null,
      "transactions": [
        "zGWVMkz0m0h22EMLL61r"
      ],
      "trials": [],
      "updated_date_unix": 1611181898,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_entries": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="gateway" data-ordernum="39"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text gateway"><h1>Gateway</h1><hr></hr><p>RevCent has different gateway entities. The site gateway, user gateway and gateway group. Each play a different role in the credit card processing system in RevCent.<br><br>We highly recommend that you read the documentation carefully to distinguish the difference between each one.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="site-gateway" data-ordernum="40"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text site-gateway"><h2>Site Gateway</h2><hr></hr><p>A site gateway is where RevCent will ultimately send transactions. You create a user gateway based on a site gateway.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="site-gateway-retrieve" data-ordernum="41"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text site-gateway-retrieve"><h3>Site Gateway Retrieve</h3><hr></hr><p>Retrieve current information on a single site gateway or multiple site gateways. This is the list of available gateways within the RevCent system. The most important part is the fields array, which is what each gateway requires for authentication.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="site-gateway-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "site_gateway",
    "method": "retrieve",
    "id": "dXAmybdWwYHrLyWRAAZV",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="site-gateway-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "8ry1n98aGMIvjrlKrKQo",
  "api_call_processed": true,
  "api_call_unix": 1676475629,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "site_gateway",
  "results": [
    {
      "description": "Authorize.net Merchant Gateway",
      "fields": [
        {
          "id": "1",
          "name": "API Login ID",
          "description": "Authorize.net API Login ID"
        },
        {
          "id": "2",
          "name": "Transaction Key",
          "description": "Authorize.net Transaction Key"
        }
      ],
      "id": "dXAmybdWwYHrLyWRAAZV",
      "name": "Authorize.net"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="user-gateway" data-ordernum="42"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-gateway"><h2>User Gateway</h2><hr></hr><p>A user gateway is essentially a MID, where you provide your credentials (fields) according to the site gateway. You create a user gateway based on a site gateway. For example, if you are creating a user gateway (MID) for Authorize.net, you would need to supply the correct number of fields, including each fields' corresponding id and value when creating the user gateway.  Read more about <a href="https://kb.revcent.com/en/payments/credit-card/gateway" target="_blank">User Gateways <i class="far fa-external-link-square-alt small"></i></a>.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="user-gateway-create" data-ordernum="43"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-gateway-create"><h3>User Gateway Create</h3><hr></hr><p>Create a user gateway within RevCent via the user gateway create method.<br><br><strong>Important</strong>: A site gateway is required, along with the correct required fields when creating a user gateway.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the gateway should be enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_success_fee<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction success fee for the user gateway. Default is 0.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_fail_fee<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction fail fee for the user gateway. Default is 0.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_rate<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount rate for the user gateway. Default is 0.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_gateway_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The site gateway ID that the user gateway will communicate with.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID for the user gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_descriptor<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor for the user gateway. Will be provided to supported gateways as well as provided as shortcodes in email templates.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable the custom descriptor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor phone.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">postal_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">global_cascade_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable global cascade rules, which will overwrite individual profile cascade rules across all payment profiles for this gateway. More info about how a cascade works within a payment profile at our <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#cascade" target="_blank">Knowledge Base</a>.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable global cascade rules for the user gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#revenue-rules" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether revenue rules are enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual revenue rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the specific revenue rule is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rule bounds to declare if a rule passes or fails. <ul><li><strong>min</strong>: The final calculation value must be greater than the Rule Value.</li> <li><strong>max</strong>: The final calculation value must be less than the Rule Value.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="float-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rule value is compared with the calculation value and bound.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source, in combination with the source value and calculation, is what is used to form the calculation value. <ul><li><strong>gateway</strong>: Transactions only from the specific gateway the rule is within.</li> <li><strong>global</strong>: All transactions regardless of gateway.</li> <li><strong>step</strong>: The active step being processed during the payment flow.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source value is specific to the source selected. <ul><li><strong>captured</strong>: Only transactions which were captured.</li> <li><strong>declined</strong>: Only transactions which were declined.</li> <li><strong>chargeback</strong>: Only transactions which were marked as charged back.</li> <li><strong>total</strong>: All transactions regardless of outcome or status.</li> <li><strong>amount</strong>: Applicable only when source is 'Active Step'. The amount for the active step being processed during the payment flow.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calculation to perform based on the source value. <ul><li><strong>count</strong>: The total number of source value items.</li> <li><strong>percent</strong>: The percentage of source value items.</li> <li><strong>sum</strong>: The sum of all source value items.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of time the rule applies in a past time range.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The time unit. Used in conjunction with the time value. <ul><li><strong>hour</strong>: Time value as hours.</li> <li><strong>day</strong>: Time value as days.</li> <li><strong>week</strong>: Time value as weeks.</li> <li><strong>month</strong>: Time value as months.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#time-rules" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether time rules are enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual time rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the specific time rule is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The start time, formatted as hh:mm:a</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The end time, formatted as hh:mm:a</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific weekday that the time rule applies. <ul><li><strong>monday</strong></li><li><strong>tuesday</strong></li><li><strong>wednesday</strong></li> <li><strong>thursday</strong></li><li><strong>friday</strong></li><li><strong>saturday</strong></li><li><strong>sunday</strong></li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges. <ul><li><strong>allow</strong>: Allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.</li> <li><strong>deny</strong>: Do not allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fields required for the user gateway based on the id of the site gateway fields.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The id for the individual field according to the site gateway fields required.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value for the individual field according to the site gateway fields required.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_descriptor<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">postal_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_group<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">global_cascade_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID associated with the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_gateway<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_fail_fee<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_success_fee<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="user-gateway-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "user_gateway",
    "method": "create",
    "name": "Authorize.net",
    "user_gateway_id": "LYE26MW8Rlh5VbJmlp2l",
    "description": "My awesome gateway.",
    "enabled": true,
    "merchant_account_id": "845678",
    "transaction_success_fee": 0.55,
    "transaction_fail_fee": 0.65,
    "discount_rate": 2.71,
    "site_gateway_id": "dXAmybdWwYHrLyWRAAZV",
    "custom_descriptor": {
      "enabled": true,
      "name": "Acme Org",
      "email": "email@acme.org",
      "url": "https://www.acme.org",
      "phone": "867-5399",
      "address": "1600 Pennsylvania Ave",
      "city": "Washington",
      "state": "DC",
      "postal_code": "20500"
    },
    "global_cascade_rules": {
      "enabled": true,
      "revenue_rules": {
        "enabled": true,
        "options": [
          {
            "enabled": true,
            "bound": "max",
            "rule_value": 5,
            "calculation": "count",
            "source": "gateway",
            "source_value": "chargeback",
            "time_value": 1,
            "time_unit": "month"
          }
        ]
      },
      "time_rules": {
        "enabled": true,
        "options": [
          {
            "start_time": "12:00am",
            "end_time": "11:59pm",
            "name": "sunday",
            "option": "deny",
            "enabled": true
          }
        ]
      }
    },
    "fields": [
      {
        "id": "1",
        "value": "ABCD123"
      },
      {
        "id": "2",
        "value": "456efG789"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="user-gateway-create-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-15T15:38:07+00:00",
  "api_call_id": "qZ90JMnBEBSOzznaldPj",
  "api_call_processed": true,
  "api_call_unix": 1676475487,
  "code": 1,
  "created_date": "2017-11-10T13:29:38+00:00",
  "created_date_unix": 1510320578,
  "custom_descriptor": {
    "enabled": true,
    "name": "Acme Org",
    "email": "email@acme.org",
    "url": "https://www.acme.org",
    "phone": "867-5399",
    "address": "1600 Pennsylvania Ave",
    "city": "Washington",
    "state": "DC",
    "postal_code": "20500"
  },
  "description": "Auth.net",
  "discount_rate": 2.5,
  "enabled": true,
  "gateway_group": [],
  "global_cascade_rules": {
    "revenue_rules": {
      "enabled": true,
      "options": [
        {
          "enabled": true,
          "bound": "max",
          "rule_value": 5,
          "calculation": "count",
          "source": "gateway",
          "source_value": "chargeback",
          "time_unit": "month",
          "time_value": 1
        }
      ]
    },
    "time_rules": {
      "enabled": true,
      "options": [
        {
          "start_time": "12:00am",
          "end_time": "11:59pm",
          "name": "sunday",
          "option": "deny",
          "enabled": true
        }
      ]
    },
    "enabled": true
  },
  "id": "LYE26MW8Rlh5VbJmlp2l",
  "merchant_account_id": "845678",
  "name": "Authorize.net",
  "request_method": "create",
  "request_type": "user_gateway",
  "result": "Gateway created.",
  "site_gateway": {
    "id": "dXAmybdWwYHrLyWRAAZV",
    "name": "Authorize.net"
  },
  "transaction_fail_fee": 0.15,
  "transaction_success_fee": 0.25,
  "updated_date": "2023-02-15T15:38:07+00:00",
  "updated_date_unix": 1676475487
}</pre></div></div></div></section><section id="user-gateway-edit" data-ordernum="44"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-gateway-edit"><h3>User Gateway Edit</h3><hr></hr><p>Edit an existing user gateway within RevCent via the user gateway edit method.<br><strong>Note:</strong> Only provide the properties you wish to modify. Properties not provided will remain unchanged.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The user gateway ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the gateway should be enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_success_fee<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction success fee for the user gateway. Default is 0.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_fail_fee<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction fail fee for the user gateway. Default is 0.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_rate<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount rate for the user gateway. Default is 0.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_gateway_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The site gateway ID that the user gateway will communicate with.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID for the user gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_descriptor<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor for the user gateway. Will be provided to supported gateways as well as provided as shortcodes in email templates.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable the custom descriptor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor phone.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">postal_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The custom descriptor postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">global_cascade_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable global cascade rules, which will overwrite individual profile cascade rules across all payment profiles for this gateway. More info about how a cascade works within a payment profile at our <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#cascade" target="_blank">Knowledge Base</a>.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable global cascade rules for the user gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#revenue-rules" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether revenue rules are enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual revenue rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the specific revenue rule is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rule bounds to declare if a rule passes or fails. <ul><li><strong>min</strong>: The final calculation value must be greater than the Rule Value.</li> <li><strong>max</strong>: The final calculation value must be less than the Rule Value.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="float-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rule value is compared with the calculation value and bound.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source, in combination with the source value and calculation, is what is used to form the calculation value. <ul><li><strong>gateway</strong>: Transactions only from the specific gateway the rule is within.</li> <li><strong>global</strong>: All transactions regardless of gateway.</li> <li><strong>step</strong>: The active step being processed during the payment flow.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source value is specific to the source selected. <ul><li><strong>captured</strong>: Only transactions which were captured.</li> <li><strong>declined</strong>: Only transactions which were declined.</li> <li><strong>chargeback</strong>: Only transactions which were marked as charged back.</li> <li><strong>total</strong>: All transactions regardless of outcome or status.</li> <li><strong>amount</strong>: Applicable only when source is 'Active Step'. The amount for the active step being processed during the payment flow.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calculation to perform based on the source value. <ul><li><strong>count</strong>: The total number of source value items.</li> <li><strong>percent</strong>: The percentage of source value items.</li> <li><strong>sum</strong>: The sum of all source value items.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of time the rule applies in a past time range.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The time unit. Used in conjunction with the time value. <ul><li><strong>hour</strong>: Time value as hours.</li> <li><strong>day</strong>: Time value as days.</li> <li><strong>week</strong>: Time value as weeks.</li> <li><strong>month</strong>: Time value as months.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#time-rules" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether time rules are enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual time rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the specific time rule is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The start time, formatted as hh:mm:a</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The end time, formatted as hh:mm:a</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific weekday that the time rule applies. <ul><li><strong>monday</strong></li><li><strong>tuesday</strong></li><li><strong>wednesday</strong></li> <li><strong>thursday</strong></li><li><strong>friday</strong></li><li><strong>saturday</strong></li><li><strong>sunday</strong></li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges. <ul><li><strong>allow</strong>: Allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.</li> <li><strong>deny</strong>: Do not allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fields required for the user gateway based on the id of the site gateway fields.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The id for the individual field according to the site gateway fields required.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value for the individual field according to the site gateway fields required.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_descriptor<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">postal_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_group<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">global_cascade_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID associated with the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_gateway<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_fail_fee<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_success_fee<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="user-gateway-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "user_gateway",
    "method": "edit",
    "name": "Authorize.net",
    "user_gateway_id": "LYE26MW8Rlh5VbJmlp2l",
    "description": "My awesome gateway.",
    "enabled": true,
    "merchant_account_id": "845678",
    "transaction_success_fee": 0.55,
    "transaction_fail_fee": 0.65,
    "discount_rate": 2.71,
    "site_gateway_id": "dXAmybdWwYHrLyWRAAZV",
    "custom_descriptor": {
      "enabled": true,
      "name": "Acme Org",
      "email": "email@acme.org",
      "url": "https://www.acme.org",
      "phone": "867-5399",
      "address": "1600 Pennsylvania Ave",
      "city": "Washington",
      "state": "DC",
      "postal_code": "20500"
    },
    "global_cascade_rules": {
      "enabled": true,
      "revenue_rules": {
        "enabled": true,
        "options": [
          {
            "enabled": true,
            "bound": "max",
            "rule_value": 5,
            "calculation": "count",
            "source": "gateway",
            "source_value": "chargeback",
            "time_value": 1,
            "time_unit": "month"
          }
        ]
      },
      "time_rules": {
        "enabled": true,
        "options": [
          {
            "start_time": "12:00am",
            "end_time": "11:59pm",
            "name": "sunday",
            "option": "deny",
            "enabled": true
          }
        ]
      }
    },
    "fields": [
      {
        "id": "1",
        "value": "ABCD123"
      },
      {
        "id": "2",
        "value": "456efG789"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="user-gateway-edit-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-15T15:38:07+00:00",
  "api_call_id": "qZ90JMnBEBSOzznaldPj",
  "api_call_processed": true,
  "api_call_unix": 1676475487,
  "code": 1,
  "created_date": "2017-11-10T13:29:38+00:00",
  "created_date_unix": 1510320578,
  "custom_descriptor": {
    "enabled": true,
    "name": "Acme Org",
    "email": "email@acme.org",
    "url": "https://www.acme.org",
    "phone": "867-5399",
    "address": "1600 Pennsylvania Ave",
    "city": "Washington",
    "state": "DC",
    "postal_code": "20500"
  },
  "description": "Auth.net",
  "discount_rate": 2.5,
  "enabled": true,
  "gateway_group": [
    {
      "id": "GOGaPRql9oUAAkrm5Ll9",
      "name": "New Group"
    }
  ],
  "global_cascade_rules": {
    "revenue_rules": {
      "enabled": true,
      "options": [
        {
          "enabled": true,
          "bound": "max",
          "rule_value": 5,
          "calculation": "count",
          "source": "gateway",
          "source_value": "chargeback",
          "time_unit": "month",
          "time_value": 1
        }
      ]
    },
    "time_rules": {
      "enabled": true,
      "options": [
        {
          "start_time": "12:00am",
          "end_time": "11:59pm",
          "name": "sunday",
          "option": "deny",
          "enabled": true
        }
      ]
    },
    "enabled": true
  },
  "id": "LYE26MW8Rlh5VbJmlp2l",
  "merchant_account_id": "845678",
  "name": "Authorize.net",
  "request_method": "edit",
  "request_type": "user_gateway",
  "result": "Gateway edited.",
  "site_gateway": {
    "id": "dXAmybdWwYHrLyWRAAZV",
    "name": "Authorize.net"
  },
  "transaction_fail_fee": 0.15,
  "transaction_success_fee": 0.25,
  "updated_date": "2023-02-15T15:38:07+00:00",
  "updated_date_unix": 1676475487
}</pre></div></div></div></section><section id="user-gateway-retrieve" data-ordernum="45"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-gateway-retrieve"><h3>User Gateway Retrieve</h3><hr></hr><p>Retrieve current information on a single user gateway or multiple user gateways.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_descriptor<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">postal_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_group<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">global_cascade_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID associated with the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_gateway<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_fail_fee<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_success_fee<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="user-gateway-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "user_gateway",
    "method": "retrieve",
    "id": "LYE26MW8Rlh5VbJmlp2l",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1,
      "status_filter": [
        "enabled"
      ]
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="user-gateway-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "8ry1nRVXMaHvjrlKrKvl",
  "api_call_processed": true,
  "api_call_unix": 1676475737,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "user_gateway",
  "results": [
    {
      "created_date_unix": 1510320578,
      "custom_descriptor": {
        "enabled": true,
        "name": "Acme Org",
        "email": "email@acme.org",
        "url": "https://www.acme.org",
        "phone": "867-5399",
        "address": "1600 Pennsylvania Ave",
        "city": "Washington",
        "state": "DC",
        "postal_code": "20500"
      },
      "description": "Auth.net",
      "discount_rate": 2.5,
      "enabled": true,
      "gateway_group": [
        {
          "id": "GOGaPRql9oUAAkrm5Ll9",
          "name": "New Group"
        }
      ],
      "global_cascade_rules": {
        "revenue_rules": {
          "enabled": true,
          "options": [
            {
              "enabled": true,
              "bound": "max",
              "rule_value": 5,
              "calculation": "count",
              "source": "gateway",
              "source_value": "chargeback",
              "time_unit": "month",
              "time_value": 1
            }
          ]
        },
        "time_rules": {
          "enabled": true,
          "options": [
            {
              "start_time": "12:00am",
              "end_time": "11:59pm",
              "name": "sunday",
              "option": "deny",
              "enabled": true
            }
          ]
        },
        "enabled": true
      },
      "id": "LYE26MW8Rlh5VbJmlp2l",
      "merchant_account_id": "845678",
      "name": "Authorize.net",
      "site_gateway": {
        "id": "dXAmybdWwYHrLyWRAAZV",
        "name": "Authorize.net"
      },
      "transaction_fail_fee": 0,
      "transaction_success_fee": 0,
      "updated_date_unix": 1676475487
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="gateway-group" data-ordernum="46"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text gateway-group"><h2>Gateway Group</h2><hr></hr><p>A gateway group is a group of gateways that can be used within a payment profile cascade. You can then add or remove a user gateway(s) from gateway groups as needed, without needing to modify the payment profile. Read more about <a href="https://kb.revcent.com/en/payments/credit-card/gateway-group" target="_blank">Gateway Groups <i class="far fa-external-link-square-alt small"></i></a>.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="gateway-group-create" data-ordernum="47"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text gateway-group-create"><h3>Gateway Group Create</h3><hr></hr><p>Create a gateway group within RevCent via the gateway group create method.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">choice_method<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method in which the gateway group will select an individual gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of user gateway IDs to have in the gateway group.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="gateway-group-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "gateway_group",
    "method": "create",
    "name": "New Group",
    "description": "Group description.",
    "choice_method": "evenly_distribute",
    "enabled": true,
    "user_gateway": [
      "LYE26MW8Rlh5VbJmlp2l",
      "8rNnkY45R4Hw1ZBg1yYB"
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="gateway-group-create-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-15T15:31:56+00:00",
  "api_call_id": "ajzVv1LMXPc0l6pQ4wLv",
  "api_call_processed": true,
  "api_call_unix": 1676475116,
  "code": 1,
  "created_date_unix": 1676475116,
  "description": "Group description",
  "enabled": true,
  "id": "2r1kMjvz2YC6bWGdjOYB",
  "name": "New Group",
  "request_method": "create",
  "request_type": "gateway_group",
  "result": "Gateway group created.",
  "updated_date_unix": 1676475116,
  "user_gateway": [
    {
      "id": "LYE26MW8Rlh5VbJmlp2l",
      "name": "Authorize.net",
      "enabled": true
    },
    {
      "id": "8rNnkY45R4Hw1ZBg1yYB",
      "name": "NMI",
      "enabled": true
    }
  ]
}</pre></div></div></div></section><section id="gateway-group-edit" data-ordernum="48"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text gateway-group-edit"><h3>Gateway Group Edit</h3><hr></hr><p>Edit an existing gateway group within RevCent via the gateway group edit method.<br><strong>Note:</strong> Only provide the properties you wish to modify. Properties not provided will remain unchanged.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_group_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway group ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">choice_method<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method in which the gateway group will select an individual gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of user gateway IDs to have in the gateway group. <strong class="text-danger">Important:</strong> This array will <u>replace</u> the gateways within a gateway group. Use the <i>add_user_gateway</i> or <i>remove_user_gateway</i> methods for adding or removing specific gateway(s) within a group while leaving the remaining user gateways.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="gateway-group-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "gateway_group",
    "method": "edit",
    "gateway_group_id": "GOGaPRql9oUAAkrm5Ll9",
    "name": "New Group",
    "description": "Group description.",
    "choice_method": "round_robin",
    "enabled": true,
    "user_gateway": [
      "8rNnkY45R4Hw1ZBg1yYB"
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="gateway-group-edit-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-15T15:31:56+00:00",
  "api_call_id": "ajzVv1LMXPc0l6pQ4wLv",
  "api_call_processed": true,
  "api_call_unix": 1676475116,
  "code": 1,
  "created_date_unix": 1676475116,
  "description": "Group description",
  "enabled": true,
  "id": "2r1kMjvz2YC6bWGdjOYB",
  "name": "New Group 2",
  "request_method": "edit",
  "request_type": "gateway_group",
  "result": "Gateway group edited.",
  "updated_date_unix": 1676475116,
  "user_gateway": [
    {
      "id": "8rNnkY45R4Hw1ZBg1yYB",
      "name": "NMI",
      "enabled": true
    }
  ]
}</pre></div></div></div></section><section id="gateway-group-add-user-gateway" data-ordernum="49"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text gateway-group-add-user-gateway"><h3>Gateway Group Add User Gateway</h3><hr></hr><p>Add a user gateway to a gateway group. Use this method to add a user gateway(s) without modifying existing user gateways in the gateway group.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_group_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway group ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of user gateway IDs to add to the gateway group.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="gateway-group-add-user-gateway-request" class="highlight-code language-json ">{
  "request": {
    "type": "gateway_group",
    "method": "add_user_gateway",
    "gateway_group_id": "GOGaPRql9oUAAkrm5Ll9",
    "user_gateway": [
      "GOJankNpkpsPzw6No1OP"
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="gateway-group-add-user-gateway-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-15T02:51:25+00:00",
  "api_call_id": "ZVAlyYEgnOSR2wEYZbZg",
  "api_call_processed": true,
  "api_call_unix": 1676429485,
  "code": 1,
  "created_date_unix": 1675884443,
  "description": "",
  "enabled": true,
  "id": "GOGaPRql9oUAAkrm5Ll9",
  "name": "New Group",
  "request_method": "add_user_gateway",
  "request_type": "gateway_group",
  "result": "Gateway added to group.",
  "updated_date_unix": 1676429485,
  "user_gateway": [
    {
      "id": "GOJankNpkpsPzw6No1OP",
      "name": "Stripe",
      "enabled": true
    },
    {
      "id": "8rNnkY45R4Hw1ZBg1yYB",
      "name": "NMI",
      "enabled": true
    }
  ]
}</pre></div></div></div></section><section id="gateway-group-remove-user-gateway" data-ordernum="50"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text gateway-group-remove-user-gateway"><h3>Gateway Group Remove User Gateway</h3><hr></hr><p>Remove a user gateway to a gateway group. Use this method to remove a user gateway(s) without modifying existing user gateways in the gateway group.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_group_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway group ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of user gateway IDs to remove from the gateway group.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="gateway-group-remove-user-gateway-request" class="highlight-code language-json ">{
  "request": {
    "type": "gateway_group",
    "method": "remove_user_gateway",
    "gateway_group_id": "GOGaPRql9oUAAkrm5Ll9",
    "user_gateway": [
      "GOJankNpkpsPzw6No1OP"
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="gateway-group-remove-user-gateway-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-15T02:51:01+00:00",
  "api_call_id": "Q4kdYEAqPkt8lO14XNXL",
  "api_call_processed": true,
  "api_call_unix": 1676429461,
  "code": 1,
  "created_date_unix": 1675884443,
  "description": "",
  "enabled": true,
  "id": "GOGaPRql9oUAAkrm5Ll9",
  "name": "New Group",
  "request_method": "remove_user_gateway",
  "request_type": "gateway_group",
  "result": "Gateway removed from group.",
  "updated_date_unix": 1676429461,
  "user_gateway": [
    {
      "id": "8rNnkY45R4Hw1ZBg1yYB",
      "name": "NMI",
      "enabled": true
    }
  ]
}</pre></div></div></div></section><section id="gateway-group-retrieve" data-ordernum="51"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text gateway-group-retrieve"><h3>Gateway Group Retrieve</h3><hr></hr><p>Retrieve current information on a single gateway group or multiple gateway groups.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_gateway<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="gateway-group-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "gateway_group",
    "method": "retrieve",
    "id": "GOGaPRql9oUAAkrm5Ll9",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1,
      "status_filter": [
        "enabled"
      ]
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="gateway-group-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "JNOdrkg91lh4LWlZWAVv",
  "api_call_processed": true,
  "api_call_unix": 1676476618,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "gateway_group",
  "results": [
    {
      "created_date_unix": 1675884443,
      "description": "",
      "enabled": true,
      "id": "GOGaPRql9oUAAkrm5Ll9",
      "name": "New Group",
      "updated_date_unix": 1676429485,
      "user_gateway": [
        {
          "id": "8rNnkY45R4Hw1ZBg1yYB",
          "name": "NMI",
          "enabled": true
        }
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="payment-profile" data-ordernum="52"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text payment-profile"><h2>Payment Profile</h2><hr></hr><p>A payment profile allows payments to flow through your processors based on specific rules, as well as process lost revenue from fully declined or partially declined payments. Read more about <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile" target="_blank">Payment Profiles <i class="far fa-external-link-square-alt small"></i></a>.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="payment-profile-create" data-ordernum="53"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text payment-profile-create"><h3>Payment Profile Create</h3><hr></hr><p>Create a payment profile within RevCent via the payment profile create method.<br><br><strong class="text-danger">Important:</strong> Payment profiles are a powerful feature, with settings and orders that require detailed precision. A misconfigured payment profile can prevent payments from processing entirely. Please read more about <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile" target="_blank">Payment Profiles <i class="far fa-external-link-square-alt small"></i></a> before proceeding.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">steps<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The steps for the payment flow. The payment flow is the core part of a payment profile and dictates what processor to use for a payment and what to do if a payment is declined. The payment flow consists of steps, each step being a payment attempt. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#payment-flow" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_options<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The options to take if the step transaction is declined.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_setting<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value in which to modify according to declined_modify.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_modify<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p><ul><li><strong>nothing</strong>: Do nothing simply ends the payment profile process at the step. The transaction is returned as declined.</li> <li><strong>nomodify</strong>: Don't Modify Amount allows you to simply proceed to another step. For example, if you wish to try another gateway without modifying the initial amount, you would choose this.</li> <li><strong>modifypct</strong>: Modify the original transaction amount by a percentage decrease. </li> <li><strong>modifyspf</strong>: Modify the original transaction amount by a fixed dollar amount decrease.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_action<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p><ul><li><strong>next</strong>: If you wish to proceed to the next step in the flow. </li> <li><strong>repeat</strong>: If you wish to repeat to the current step one more time.</li> <li><strong>nothing</strong>: If you wish to end the payment flow.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of the step within the array of steps.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p><ul><li><strong>gateway</strong>: Process step transaction using a specific gateway.</strong></li> <li><strong>cascade</strong>: Process step transaction using the cascade.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p><ul><li><strong>sort_order</strong>: Process valid gateways in the sort order within the cascade, beginning with gateway 1 in the cascade. I.e. if gateway 1 is valid, then it will be used, else gateway 2 if valid, and so on.</li> <li><strong>round_robin</strong>: Process cascade gateways in the sort order within the cascade, beginning with the next gateway after the last transaction gateway used in the cascade sort order. I.e. if gateway 1 was last used, then gateway 2 will be used if valid. If gateway 3 is last used, and is the last gateway in the rotation, then the rotation resets and gateway 1 will be used if valid. </li> <li><strong>evenly_distribute</strong>: Process valid gateways by even distribution of total captured payment volume <u>within the past 24 hours</u>. Sort order in the cascade is ignored. Instead, least captured payment volume is what determines which gateway will be used. I.e. If gateway X has total captured payment volume of $210, gateway Y has total captured payment volume of $200 and gateway Z has total captured payment volume of $230, then gateway Y will be used as it has the least total captured payment volume.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway, if source is gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">swap_card<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to try a different card if a preceeding step is declined.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A payment profile cascade allows you to process transactions at specific gateways using a specific order and set rules for each gateway. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#cascade" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_source<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source of items for the cascade. <ul><li><strong>gateways</strong>: Use the list of gateway(s) as the cascade source.</li><li><strong>gateway_groups</strong>: Use the list of gateway group(s) as the cascade source.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateways<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A list of one or more gateways to use as the source within the cascade. <a href="https://kb.revcent.com/en/payments/credit-card/gateway" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#revenue-rules" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether revenue rules are enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual revenue rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the specific revenue rule is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rule bounds to declare if a rule passes or fails. <ul><li><strong>min</strong>: The final calculation value must be greater than the Rule Value.</li> <li><strong>max</strong>: The final calculation value must be less than the Rule Value.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="float-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rule value is compared with the calculation value and bound.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source, in combination with the source value and calculation, is what is used to form the calculation value. <ul><li><strong>gateway</strong>: Transactions only from the specific gateway the rule is within.</li> <li><strong>global</strong>: All transactions regardless of gateway.</li> <li><strong>step</strong>: The active step being processed during the payment flow.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source value is specific to the source selected. <ul><li><strong>captured</strong>: Only transactions which were captured.</li> <li><strong>declined</strong>: Only transactions which were declined.</li> <li><strong>chargeback</strong>: Only transactions which were marked as charged back.</li> <li><strong>total</strong>: All transactions regardless of outcome or status.</li> <li><strong>amount</strong>: Applicable only when source is 'Active Step'. The amount for the active step being processed during the payment flow.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calculation to perform based on the source value. <ul><li><strong>count</strong>: The total number of source value items.</li> <li><strong>percent</strong>: The percentage of source value items.</li> <li><strong>sum</strong>: The sum of all source value items.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of time the rule applies in a past time range.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The time unit. Used in conjunction with the time value. <ul><li><strong>hour</strong>: Time value as hours.</li> <li><strong>day</strong>: Time value as days.</li> <li><strong>week</strong>: Time value as weeks.</li> <li><strong>month</strong>: Time value as months.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#time-rules" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether time rules are enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual time rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the specific time rule is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The start time, formatted as hh:mm:a</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The end time, formatted as hh:mm:a</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific weekday that the time rule applies. <ul><li><strong>monday</strong></li><li><strong>tuesday</strong></li><li><strong>wednesday</strong></li> <li><strong>thursday</strong></li><li><strong>friday</strong></li><li><strong>saturday</strong></li><li><strong>sunday</strong></li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges. <ul><li><strong>allow</strong>: Allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.</li> <li><strong>deny</strong>: Do not allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the gateway is enabled within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order in which the gateway resides in the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_groups<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A list of one or more gateway groups to use as the source within the cascade. <a href="https://kb.revcent.com/en/payments/credit-card/gateway-group" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the gateway group is enabled within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order in which the gateway group resides in the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway group.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">kill_terms<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>You have the ability to cancel the payment profile flow if a declined transaction has specific terms/phrases/words in a step gateways' decline response. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#kill-terms" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable kill terms.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">terms<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of one or more kill terms. Kill terms are case-insensitive. This will also cancel/void the related sale being attempted. Only applies to initial sale attempts, not renewals or trial expirations.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_attempts<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>You have the ability to cancel/void a sale if the number of declined payment profile attempts reaches a certain number. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#max-attempts" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable max attempts.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of failed payment profile attempts, where once reached, the sale being processed will automatically be cancelled/voided.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">global_cascade_rules_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_groups<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">kill_terms<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">terms<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_attempts<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">steps<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_options<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_modify<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway</div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">swap_card<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="payment-profile-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "payment_profile",
    "method": "create",
    "name": "My Payment Profile",
    "description": "",
    "enabled": true,
    "steps": [
      {
        "declined_options": {
          "declined_setting": "modifypct",
          "declined_modify": "10",
          "declined_action": "next"
        },
        "order": 1,
        "source": "cascade",
        "cascade_order": "round_robin",
        "gateway": "LYE26MW8Rlh5VbJmlp2l",
        "swap_card": false
      },
      {
        "declined_options": {
          "declined_setting": "nothing",
          "declined_modify": "0",
          "declined_action": "nothing"
        },
        "order": 2,
        "source": "gateway",
        "cascade_order": "round_robin",
        "gateway": "8rNnkY45R4Hw1ZBg1yYB",
        "swap_card": true
      }
    ],
    "cascade": {
      "cascade_source": "gateway_groups",
      "gateways": [
        {
          "revenue_rules": {
            "enabled": true,
            "options": [
              {
                "enabled": true,
                "bound": "max",
                "rule_value": 5,
                "calculation": "count",
                "source": "gateway",
                "source_value": "chargeback",
                "time_value": 1,
                "time_unit": "month"
              }
            ]
          },
          "time_rules": {
            "enabled": true,
            "options": [
              {
                "start_time": "12:00am",
                "end_time": "11:59pm",
                "name": "sunday",
                "option": "deny",
                "enabled": true
              }
            ]
          },
          "enabled": true,
          "order": 1,
          "id": "LYE26MW8Rlh5VbJmlp2l"
        }
      ],
      "gateway_groups": [
        {
          "enabled": false,
          "order": 1,
          "id": "GOGaPRql9oUAAkrm5Ll9"
        }
      ]
    },
    "kill_terms": {
      "enabled": true,
      "terms": [
        "NSF"
      ]
    },
    "max_attempts": {
      "enabled": true,
      "num": 1
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="payment-profile-create-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-17T20:01:46+00:00",
  "api_call_id": "zGJbyZPNQkILyN9Z6L4a",
  "api_call_processed": true,
  "api_call_unix": 1676664106,
  "cascade": {
    "cascade_source": "gateway_groups",
    "gateways": [
      {
        "enabled": true,
        "order": 1,
        "id": "LYE26MW8Rlh5VbJmlp2l",
        "global_cascade_rules_enabled": true,
        "revenue_rules": {
          "enabled": true,
          "options": [
            {
              "enabled": true,
              "bound": "max",
              "rule_value": 5,
              "calculation": "count",
              "source": "gateway",
              "source_value": "chargeback",
              "time_unit": "month",
              "time_value": 1
            }
          ]
        },
        "time_rules": {
          "enabled": true,
          "options": [
            {
              "start_time": "12:00am",
              "end_time": "11:59pm",
              "name": "sunday",
              "option": "deny",
              "enabled": true
            }
          ]
        },
        "name": "Authorize.net"
      }
    ],
    "gateway_groups": [
      {
        "enabled": false,
        "order": 1,
        "id": "GOGaPRql9oUAAkrm5Ll9",
        "name": "New Group"
      }
    ]
  },
  "code": 1,
  "created_date": "2023-02-17T20:01:46+00:00",
  "created_date_unix": 1676664106,
  "description": "",
  "enabled": true,
  "id": "RJ0YXwdGzbFpXO9ENpqw",
  "kill_terms": {
    "enabled": true,
    "terms": [
      "NSF"
    ]
  },
  "max_attempts": {
    "enabled": true,
    "num": 1
  },
  "name": "My Payment Profile",
  "request_method": "create",
  "request_type": "payment_profile",
  "result": "Payment profile created.",
  "steps": [
    {
      "declined_options": {
        "declined_action": "next",
        "declined_modify": "10",
        "declined_setting": "modifypct"
      },
      "cascade_order": "round_robin",
      "source": "cascade",
      "gateway": null,
      "swap_card": false,
      "order": 1
    },
    {
      "declined_options": {
        "declined_action": "nothing",
        "declined_modify": "0",
        "declined_setting": "nothing"
      },
      "cascade_order": "round_robin",
      "source": "gateway",
      "gateway": "8rNnkY45R4Hw1ZBg1yYB",
      "swap_card": true,
      "order": 2
    }
  ],
  "updated_date": "2023-02-17T20:01:46+00:00",
  "updated_date_unix": 1676664106
}</pre></div></div></div></section><section id="payment-profile-edit" data-ordernum="54"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text payment-profile-edit"><h3>Payment Profile Edit</h3><hr></hr><p>Edit an existing payment profile within RevCent via the payment profile edit method.<br><strong>Note:</strong> Only provide the properties you wish to modify. Properties not provided will remain unchanged.<br><br><strong class="text-danger">Important:</strong> Payment profiles are a powerful feature, with settings and orders that require detailed precision. A misconfigured payment profile can prevent payments from processing entirely. Please read more about <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile" target="_blank">Payment Profiles <i class="far fa-external-link-square-alt small"></i></a> before proceeding.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the payment profile you are modifying.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">steps<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The steps for the payment flow. The payment flow is the core part of a payment profile and dictates what processor to use for a payment and what to do if a payment is declined. The payment flow consists of steps, each step being a payment attempt. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#payment-flow" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_options<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The options to take if the step transaction is declined.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_setting<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value in which to modify according to declined_modify.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_modify<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p><ul><li><strong>nothing</strong>: Do nothing simply ends the payment profile process at the step. The transaction is returned as declined.</li> <li><strong>nomodify</strong>: Don't Modify Amount allows you to simply proceed to another step. For example, if you wish to try another gateway without modifying the initial amount, you would choose this.</li> <li><strong>modifypct</strong>: Modify the original transaction amount by a percentage decrease. </li> <li><strong>modifyspf</strong>: Modify the original transaction amount by a fixed dollar amount decrease.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_action<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p><ul><li><strong>next</strong>: If you wish to proceed to the next step in the flow. </li> <li><strong>repeat</strong>: If you wish to repeat to the current step one more time.</li> <li><strong>nothing</strong>: If you wish to end the payment flow.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of the step within the array of steps.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p><ul><li><strong>gateway</strong>: Process step transaction using a specific gateway.</strong></li> <li><strong>cascade</strong>: Process step transaction using the cascade.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p><ul><li><strong>sort_order</strong>: Process valid gateways in the sort order within the cascade, beginning with gateway 1 in the cascade. I.e. if gateway 1 is valid, then it will be used, else gateway 2 if valid, and so on.</li> <li><strong>round_robin</strong>: Process cascade gateways in the sort order within the cascade, beginning with the next gateway after the last transaction gateway used in the cascade sort order. I.e. if gateway 1 was last used, then gateway 2 will be used if valid. If gateway 3 is last used, and is the last gateway in the rotation, then the rotation resets and gateway 1 will be used if valid. </li> <li><strong>evenly_distribute</strong>: Process valid gateways by even distribution of total captured payment volume <u>within the past 24 hours</u>. Sort order in the cascade is ignored. Instead, least captured payment volume is what determines which gateway will be used. I.e. If gateway X has total captured payment volume of $210, gateway Y has total captured payment volume of $200 and gateway Z has total captured payment volume of $230, then gateway Y will be used as it has the least total captured payment volume.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway, if source is gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">swap_card<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to try a different card if a preceeding step is declined.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A payment profile cascade allows you to process transactions at specific gateways using a specific order and set rules for each gateway. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#cascade" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_source<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source of items for the cascade. <ul><li><strong>gateways</strong>: Use the list of gateway(s) as the cascade source.</li><li><strong>gateway_groups</strong>: Use the list of gateway group(s) as the cascade source.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateways<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A list of one or more gateways to use as the source within the cascade. <a href="https://kb.revcent.com/en/payments/credit-card/gateway" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#revenue-rules" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether revenue rules are enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual revenue rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the specific revenue rule is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rule bounds to declare if a rule passes or fails. <ul><li><strong>min</strong>: The final calculation value must be greater than the Rule Value.</li> <li><strong>max</strong>: The final calculation value must be less than the Rule Value.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="float-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rule value is compared with the calculation value and bound.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source, in combination with the source value and calculation, is what is used to form the calculation value. <ul><li><strong>gateway</strong>: Transactions only from the specific gateway the rule is within.</li> <li><strong>global</strong>: All transactions regardless of gateway.</li> <li><strong>step</strong>: The active step being processed during the payment flow.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source value is specific to the source selected. <ul><li><strong>captured</strong>: Only transactions which were captured.</li> <li><strong>declined</strong>: Only transactions which were declined.</li> <li><strong>chargeback</strong>: Only transactions which were marked as charged back.</li> <li><strong>total</strong>: All transactions regardless of outcome or status.</li> <li><strong>amount</strong>: Applicable only when source is 'Active Step'. The amount for the active step being processed during the payment flow.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calculation to perform based on the source value. <ul><li><strong>count</strong>: The total number of source value items.</li> <li><strong>percent</strong>: The percentage of source value items.</li> <li><strong>sum</strong>: The sum of all source value items.</li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of time the rule applies in a past time range.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The time unit. Used in conjunction with the time value. <ul><li><strong>hour</strong>: Time value as hours.</li> <li><strong>day</strong>: Time value as days.</li> <li><strong>week</strong>: Time value as weeks.</li> <li><strong>month</strong>: Time value as months.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#time-rules" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether time rules are enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual time rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the specific time rule is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The start time, formatted as hh:mm:a</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The end time, formatted as hh:mm:a</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific weekday that the time rule applies. <ul><li><strong>monday</strong></li><li><strong>tuesday</strong></li><li><strong>wednesday</strong></li> <li><strong>thursday</strong></li><li><strong>friday</strong></li><li><strong>saturday</strong></li><li><strong>sunday</strong></li></ul></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges. <ul><li><strong>allow</strong>: Allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.</li> <li><strong>deny</strong>: Do not allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the gateway is enabled within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order in which the gateway resides in the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_groups<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A list of one or more gateway groups to use as the source within the cascade. <a href="https://kb.revcent.com/en/payments/credit-card/gateway-group" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the gateway group is enabled within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order in which the gateway group resides in the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway group.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">kill_terms<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>You have the ability to cancel the payment profile flow if a declined transaction has specific terms/phrases/words in a step gateways' decline response. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#kill-terms" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable kill terms.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">terms<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of one or more kill terms. Kill terms are case-insensitive. This will also cancel/void the related sale being attempted. Only applies to initial sale attempts, not renewals or trial expirations.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_attempts<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>You have the ability to cancel/void a sale if the number of declined payment profile attempts reaches a certain number. <a href="https://kb.revcent.com/en/payments/credit-card/payment-profile#max-attempts" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to enable max attempts.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of failed payment profile attempts, where once reached, the sale being processed will automatically be cancelled/voided.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">global_cascade_rules_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_groups<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">kill_terms<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">terms<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_attempts<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">steps<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_options<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_modify<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway</div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">swap_card<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="payment-profile-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "payment_profile",
    "method": "edit",
    "payment_profile_id": "RJ0YXwdGzbFpXO9ENpqw",
    "name": "My Payment Profile",
    "description": "",
    "enabled": true,
    "steps": [
      {
        "declined_options": {
          "declined_setting": "modifypct",
          "declined_modify": "10",
          "declined_action": "next"
        },
        "order": 1,
        "source": "cascade",
        "cascade_order": "round_robin",
        "gateway": "LYE26MW8Rlh5VbJmlp2l",
        "swap_card": false
      },
      {
        "declined_options": {
          "declined_setting": "nothing",
          "declined_modify": "0",
          "declined_action": "nothing"
        },
        "order": 2,
        "source": "gateway",
        "cascade_order": "round_robin",
        "gateway": "8rNnkY45R4Hw1ZBg1yYB",
        "swap_card": true
      }
    ],
    "cascade": {
      "cascade_source": "gateways",
      "gateways": [
        {
          "revenue_rules": {
            "enabled": true,
            "options": [
              {
                "enabled": true,
                "bound": "max",
                "rule_value": 5,
                "calculation": "count",
                "source": "gateway",
                "source_value": "chargeback",
                "time_value": 1,
                "time_unit": "month"
              }
            ]
          },
          "time_rules": {
            "enabled": false,
            "options": [
              {
                "start_time": "12:00am",
                "end_time": "11:59pm",
                "name": "sunday",
                "option": "deny",
                "enabled": true
              }
            ]
          },
          "enabled": true,
          "order": 1,
          "id": "LYE26MW8Rlh5VbJmlp2l"
        }
      ],
      "gateway_groups": [
        {
          "enabled": false,
          "order": 1,
          "id": "GOGaPRql9oUAAkrm5Ll9"
        }
      ]
    },
    "kill_terms": {
      "enabled": true,
      "terms": [
        "NSF"
      ]
    },
    "max_attempts": {
      "enabled": true,
      "num": 1
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="payment-profile-edit-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-17T20:04:23+00:00",
  "api_call_id": "6rQPpKLzmnhmLOpQ5JlL",
  "api_call_processed": true,
  "api_call_unix": 1676664263,
  "cascade": {
    "cascade_source": "gateways",
    "gateways": [
      {
        "enabled": true,
        "order": 1,
        "id": "LYE26MW8Rlh5VbJmlp2l",
        "global_cascade_rules_enabled": true,
        "revenue_rules": {
          "enabled": true,
          "options": [
            {
              "enabled": true,
              "bound": "max",
              "rule_value": 5,
              "calculation": "count",
              "source": "gateway",
              "source_value": "chargeback",
              "time_unit": "month",
              "time_value": 1
            }
          ]
        },
        "time_rules": {
          "enabled": true,
          "options": [
            {
              "start_time": "12:00am",
              "end_time": "11:59pm",
              "name": "sunday",
              "option": "deny",
              "enabled": true
            }
          ]
        },
        "name": "Authorize.net"
      }
    ],
    "gateway_groups": [
      {
        "enabled": false,
        "order": 1,
        "id": "GOGaPRql9oUAAkrm5Ll9",
        "name": "New Group"
      }
    ]
  },
  "code": 1,
  "created_date": "2023-02-17T20:01:46+00:00",
  "created_date_unix": 1676664106,
  "description": "",
  "enabled": true,
  "id": "RJ0YXwdGzbFpXO9ENpqw",
  "kill_terms": {
    "enabled": true,
    "terms": [
      "NSF"
    ]
  },
  "max_attempts": {
    "enabled": true,
    "num": 1
  },
  "name": "My Payment Profile",
  "request_method": "edit",
  "request_type": "payment_profile",
  "result": "Payment profile edited.",
  "steps": [
    {
      "declined_options": {
        "declined_setting": "modifypct",
        "declined_modify": "10",
        "declined_action": "next"
      },
      "source": "cascade",
      "cascade_order": "round_robin",
      "gateway": null,
      "swap_card": false,
      "order": 1
    },
    {
      "declined_options": {
        "declined_setting": "nothing",
        "declined_modify": "0",
        "declined_action": "nothing"
      },
      "source": "gateway",
      "cascade_order": "round_robin",
      "gateway": "8rNnkY45R4Hw1ZBg1yYB",
      "swap_card": true,
      "order": 2
    }
  ],
  "updated_date": "2023-02-17T20:04:23+00:00",
  "updated_date_unix": 1676664263
}</pre></div></div></div></section><section id="payment-profile-retrieve" data-ordernum="55"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text payment-profile-retrieve"><h3>Payment Profile Retrieve</h3><hr></hr><p>Retrieve current information on a single payment profile or multiple payment profiles.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">global_cascade_rules_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bound<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rule_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calculation<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">options<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">start_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_time<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">option<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_groups<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">kill_terms<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">terms<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_attempts<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">steps<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_options<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_modify<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">swap_card<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="payment-profile-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "payment_profile",
    "method": "retrieve",
    "id": "2r1Wo7KvJ6slWE99XK5y",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1,
      "status_filter": [
        "enabled"
      ]
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="payment-profile-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "ZVA1wj2YoRCqY0a8Mz8m",
  "api_call_processed": true,
  "api_call_unix": 1676663664,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "payment_profile",
  "results": [
    {
      "cascade": {
        "cascade_source": "gateways",
        "gateways": [
          {
            "enabled": true,
            "order": 1,
            "id": "LYE26MW8Rlh5VbJmlp2l",
            "global_cascade_rules_enabled": true,
            "revenue_rules": {
              "enabled": true,
              "options": [
                {
                  "enabled": true,
                  "bound": "max",
                  "rule_value": 5,
                  "calculation": "count",
                  "source": "gateway",
                  "source_value": "chargeback",
                  "time_unit": "month",
                  "time_value": 1
                }
              ]
            },
            "time_rules": {
              "enabled": true,
              "options": [
                {
                  "start_time": "12:00am",
                  "end_time": "11:59pm",
                  "name": "sunday",
                  "option": "deny",
                  "enabled": true
                }
              ]
            },
            "name": "Authorize.net"
          }
        ],
        "gateway_groups": [
          {
            "enabled": false,
            "order": 1,
            "id": "GOGaPRql9oUAAkrm5Ll9",
            "name": "My Gatewway Group"
          }
        ]
      },
      "created_date_unix": 1676657587,
      "description": "",
      "enabled": false,
      "id": "2r1Wo7KvJ6slWE99XK5y",
      "kill_terms": {
        "enabled": true,
        "terms": [
          "pick up card"
        ]
      },
      "max_attempts": {
        "enabled": true,
        "num": 2
      },
      "name": "My Payment Profile",
      "steps": [
        {
          "declined_options": {
            "declined_setting": "modifypct",
            "declined_modify": "15",
            "declined_action": "next"
          },
          "source": "cascade",
          "cascade_order": "evenly_distribute",
          "gateway": null,
          "swap_card": false,
          "order": 1
        },
        {
          "declined_options": {
            "declined_setting": "nothing",
            "declined_modify": "0",
            "declined_action": "nothing"
          },
          "source": "gateway",
          "cascade_order": "round_robin",
          "gateway": "8rNnkY45R4Hw1ZBg1yYB",
          "swap_card": true,
          "order": 2
        }
      ],
      "updated_date_unix": 1676661655
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="invoice" data-ordernum="56"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text invoice"><h2>Invoice</h2><hr></hr><p>An Invoice is a pending sale with an option to pay online. The only difference between an invoice and a vanilla pending sale is the Hosted Page integration, allowing the customer to pay the amount due online at via a customizable web page.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="invoice-create" data-ordernum="57"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text invoice-create"><h3>Invoice Create</h3><hr></hr><p>Create an invoice via the invoice create method. All fields that are available in a regular Sale Create API call, with the exception of the payment object, are also available i.e. discounts, shipping, etc.</p><div class="alert alert-default"><p><strong>AdWords Integration</strong></p><p>If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID. Read more about integrating AdWords with RevCent on our <a href="https://kb.revcent.com/en/tracking/google-adwords" target="_blank">Knowledge Base <i class="far fa-external-link-square-alt small"></i></a>. </p><p><i>Example</i></p><pre>"metadata":[{"name": "adwords_click", "value": "ADWORDS_CLICK_ID_HERE"}]</pre></div><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoice_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The invoice type. Always set to "sale_create".</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoice_profile<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The invoice profile ID to associate with the invoice being created. This determines the hosted page markup and URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code. If not provided default is 'USD'.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product array contains individual product objects.<br><br>Pricing is automatically calculated based upon the quantity, price or both if present.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price, if different from the product default price, you wish to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity. Default is 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_end_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_days<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending after the number of days provided.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object receives first priority as details if creating a new customer.<br><br>If the customer object is not present the bill_to and ship_to objects will be used in the respective order.<br><br>If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.<br><br>This does not apply if using a customer_id field in the request where applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Hosted Page URL for online payment.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoice_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The newly created invoice ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoice_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">metadata<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The metadata array containing name:value objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">entry_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name property for the metadata object.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value property for the metadata object.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sale ID for the invoice.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="invoice-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "invoice",
    "method": "create",
    "invoice_type": "sale_create",
    "invoice_profile": "gYo0YVd24Qf7QvdBYM2O",
    "iso_currency": "USD",
    "product": [
      {
        "id": "av_2017",
        "price": 19.99,
        "quantity": 2
      }
    ],
    "campaign": "Adwords Campaign",
    "customer": {
      "first_name": "George",
      "last_name": "Washington",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "george@whitehouse.gov",
      "phone": "1234567890"
    },
    "metadata": [
      {
        "name": "invoice_create",
        "value": "test"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="invoice-create-response" class="highlight-code language-json ">{
  "amount_total": 176.79,
  "api_call": {
    "id": "ZVRV87lEoLuKWJY5gg8z"
  },
  "api_call_id": "ZVRV87lEoLuKWJY5gg8z",
  "api_call_processed": true,
  "api_call_unix": 1602980700,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "georgew@whitehouse.com",
    "enabled": true,
    "first_name": "George",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "pres_0001",
    "last_name": "Washington",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "customer_id": "8rQrl21wjYcvJkzLaad8",
  "hosted_url": "https://securehost.revcent.com/MyCompanyName/invoice?invoice_id=ajqjGdVO9Bi1Ly2nkkW7",
  "invoice_id": "ajqjGdVO9Bi1Ly2nkkW7",
  "invoice_profile": {
    "id": "gYo0YVd24Qf7QvdBYM2O",
    "name": "tqawqtq"
  },
  "iso_currency": "USD",
  "metadata": [
    {
      "entry_date": "2020-10-18",
      "name": "invoice_create",
      "value": "test"
    }
  ],
  "request_method": "create",
  "request_type": "invoice",
  "result": "Invoice created.",
  "sale_id": "mJqJ6mnGbrUwmG0q22V9",
  "status": "Unpaid"
}</pre></div></div></div></section><section id="invoice-retrieve" data-ordernum="58"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text invoice-retrieve"><h3>Invoice Retrieve</h3><hr></hr><p>Retrieve current information on a single invoice or multiple invoices.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">date_paid<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">download_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoice_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_sale<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_subscription_renewal<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">license_keys<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of RevCent license key ID's associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paid<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quota_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing quota account IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revcent_shop<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted shopping cart that item originated from.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_account_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_item_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_items<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">void<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="invoice-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "invoice",
    "method": "retrieve",
    "id": "bOqOV2gJ6nca1aKq1Ezb"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="invoice-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "d959LvNN6ytzWzGvW5J6",
  "api_call_processed": true,
  "api_call_unix": 1602978780,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "invoice",
  "results": [
    {
      "amount_original_total": 176.79,
      "amount_total": 176.79,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1602978433,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "date_paid": null,
      "discounts": [],
      "download_url": "",
      "hosted_url": "https://securehost.revcent.com/MyCompanyName/invoice?invoice_id=bOqOV2gJ6nca1aKq1Ezb",
      "id": "bOqOV2gJ6nca1aKq1Ezb",
      "invoice_profile": {
        "id": "gYo0YVd24Qf7QvdBYM2O",
        "name": "tqawqtq"
      },
      "is_sale": true,
      "is_subscription_renewal": false,
      "iso_currency": "USD",
      "license_keys": [],
      "metadata": [
        {
          "entry_date": "2020-10-17",
          "name": "invoice_create",
          "value": "test"
        }
      ],
      "notes": [],
      "offline_payments": [],
      "paid": false,
      "payment_type": null,
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [],
      "quota_accounts": [],
      "revcent_shop": null,
      "sales": [
        "4ryrgOZkvAtKNK9wNv8l"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Unpaid",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [],
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1602978433,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_invoices": [],
      "usage_items": [],
      "void": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="license-key" data-ordernum="59"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text license-key"><h2>License Key</h2><hr></hr><p>A license key is created via web app import, remote request or auto generated by RevCent. A license key is issued when a product is purchased that has an attached license key profile. We highly recommend you read more about license key management at our <a href="https://kb.revcent.com/en/revenue/license-key-management" target="_blank">Knowledge Base <i class="far fa-external-link-square-alt small"></i></a></p></div><div class="api-section-img col-xs-hidden"> <a href="https://cdn.revcent.com/img/docs-img/api-img/license-key-explained.png" data-toggle="lightbox" data-type="image"> <img src="https://cdn.revcent.com/img/docs-img/api-img/license-key-explained.png" class="img-thumbnail"> </a> <p><a class="" href="https://cdn.revcent.com/img/docs-img/api-img/license-key-explained.png" download target="_blank">Download PNG <i class="far fa-external-link-square-alt small"></i></a></p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="license-key-retrieve" data-ordernum="60"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text license-key-retrieve"><h3>License Key Retrieve</h3><hr></hr><p>Retrieve current information on a single license key or multiple license keys.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the license key OR the license key value. Required if multiple property equals false or is not present.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the license key is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expired_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the license key was expired. Only for keys with a license key profile with expired settings.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expired_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date as a unix timestamp the license key was expired. Only for keys with a license key profile with expired settings.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_expired<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the license key is expired after being issued.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_issued<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the license key has been issued as a result of a successful purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">issued_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the license key was issued as a result of a successful purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">issued_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date as a unix timestamp the license key was issued as a result of a successful purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">license_key_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The license key profile related to the license key.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">license_key_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source of the license key. Remote, imported or RevCent generated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party shop related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_account_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage account IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_item_invoices<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item invoice IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_items<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing usage item IDs related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="license-key-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "license_key",
    "method": "retrieve",
    "id": "0pZwRNgwKwIXvMKKBbpZ"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="license-key-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "KngPNGlrqvikawbWlGXr",
  "api_call_processed": true,
  "api_call_unix": 1592237703,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "license_key",
  "results": [
    {
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "check_directs": [],
      "created_date_unix": 1591892064,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [
        "LYg5NmwXlYhJoyll4wgZ"
      ],
      "enabled": true,
      "expired_date": null,
      "expired_date_unix": null,
      "id": "0pZwRNgwKwIXvMKKBbpZ",
      "internal_id": "",
      "invoices": [],
      "is_expired": false,
      "is_issued": true,
      "issued_date": "2020-06-11T16:14:30+00:00",
      "issued_date_unix": 1591892070,
      "license_key_profile": {
        "id": "0pZwpLpPw4UrdOkQpqyv",
        "name": "Imported Keys Only"
      },
      "license_key_source": "imported",
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "P6g5kEaEzjt6VyllpEGL"
      ],
      "sale": {
        "id": "qZEBboR8W0hOPpVV02rZ"
      },
      "sales": [
        "qZEBboR8W0hOPpVV02rZ"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Enabled",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [
        "ZV7EmNBNP5TA7122OyKX"
      ],
      "third_party_shop": null,
      "transactions": [
        "EMgw2p6q5MfEnm55pPag"
      ],
      "trials": [],
      "updated_date_unix": 1591892070,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="metadata" data-ordernum="61"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text metadata"><h2>Metadata</h2><hr></hr><p>You can insert additional metadata for an entity within RevCent that will simultaneously insert the metadata to the customer related to the entity. You also have the option to cascade metadata to all related items. Useful for updating an item with metadata after it has been created.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="metadata-insert" data-ordernum="62"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text metadata-insert"><h3>Metadata Insert</h3><hr></hr><p>Insert additional metadata for a specific entity such as a customer, sale, shipping, etc. Indicate the entity using the item_type and item_id properties, the item_type being either sale, customer, shipping, etc., and item_id being the RevCent ID for the item. For example, if you want to insert additional metadata for a sale, set item_type = "sale" and item_id="REVCENT_SALE_ID".<br><br><strong>Accepted Item Types</strong><br><dl class="dl-horizontal"><dt>customer<dt><dd>A customer within RevCent.</dd><dt>sale<dt><dd>A sale within RevCent.</dd><dt>product_sale<dt><dd>A product sale within RevCent.</dd><dt>shipping<dt><dd>A shipping within RevCent.</dd><dt>subscription<dt><dd>A subscription within RevCent.</dd><dt>subscription_renewal<dt><dd>A subscription renewal within RevCent.</dd></dl></p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">item_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The item type the metadata is being inserted to, i.e. sale, customer, etc.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">item_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item type that the metadata is being inserted to. I.e. sale ID, customer ID, etc.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether or not to cascade inserted metadata into all sub related items. Default is false. For example, if inserting to sale, any shipping, subscriptions, etc. related to the sale will also have the metadata automatically inserted. Metadata will always be inserted to a related customer record regardless of cascade value.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">metadata<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The metadata you wish to insert.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name property for the metadata object.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value property for the metadata object.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">metadata<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The metadata array containing name:value objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">entry_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the metadata entry was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name property for the metadata object.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value property for the metadata object.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">item_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the item the note was created for.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">item_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The item type the note was created for.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">metadata<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The metadata inserted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="metadata-insert-request" class="highlight-code language-json ">{
  "request": {
    "type": "metadata",
    "method": "insert",
    "item_type": "sale",
    "item_id": "pgm1q7yjKjF7qyAM7EXK",
    "cascade": false,
    "metadata": [
      {
        "name": "new_name",
        "value": "new value"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="metadata-insert-response" class="highlight-code language-json ">{
  "api_call_date": "2022-06-02T15:16:15+00:00",
  "api_call_id": "JNGoAdZ7v8iRooaArOOy",
  "api_call_processed": true,
  "api_call_unix": 1654182975,
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "georgew@whitehouse.com",
    "enabled": true,
    "first_name": "George",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "pres_0001",
    "last_name": "Washington",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "item_id": "pgm1q7yjKjF7qyAM7EXK",
  "item_type": "sale",
  "metadata": [
    {
      "name": "new_name",
      "value": "new value"
    }
  ],
  "request_method": "insert",
  "request_type": "metadata",
  "result": "Metadata inserted."
}</pre></div></div></div></section><section id="note" data-ordernum="63"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text note"><h2>Note</h2><hr></hr><p>You can create a note for an entity within RevCent that will simultaneously attach the note to the customer related to the entity. This allows you to view all notes for a customer and related entities.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="note-create" data-ordernum="64"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text note-create"><h3>Note Create</h3><hr></hr><p>Create a note for a specific entity such as a customer, sale, shipping, etc. Indicate the entity using the item_type and item_id properties, the item_type being either sale, customer, shipping, etc., and item_id being the RevCent ID for the item. For example, if you want to leave a note for a sale, set item_type = "sale" and item_id="REVCENT_SALE_ID".<br><br><strong>Accepted Item Types</strong><br><dl class="dl-horizontal"><dt>customer<dt><dd>A customer within RevCent.</dd><dt>sale<dt><dd>A sale within RevCent.</dd><dt>product_sale<dt><dd>A product sale within RevCent.</dd><dt>shipping<dt><dd>A shipping within RevCent.</dd><dt>subscription<dt><dd>A subscription within RevCent.</dd><dt>subscription_renewal<dt><dd>A subscription renewal within RevCent.</dd><dt>chargeback<dt><dd>A chargeback within RevCent.</dd></dl></p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">item_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The item type the note is to be created for. Example: sale, customer, shipping, etc.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">item_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the item the note is to be created for. If item_type = sale, then the RevCent sale ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">text<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The note text.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">item_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the item the note was created for.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">item_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The item type the note was created for.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">note_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the note created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="note-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "note",
    "method": "create",
    "item_type": "sale",
    "item_id": "pgm1q7yjKjF7qyAM7EXK",
    "text": "Making a note for a sale with RevCent ID pgm1q7yjKjF7qyAM7EXK."
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="note-create-response" class="highlight-code language-json ">{
  "api_call_id": "WmEZRkNmKRhmWBrkNP9B",
  "api_call_processed": true,
  "api_call_unix": 1638047347,
  "code": 1,
  "item_id": "pgm1q7yjKjF7qyAM7EXK",
  "item_type": "sale",
  "note_id": "4rAmyMargyuMaXrkQLyK",
  "request_method": "create",
  "request_type": "note",
  "result": "Note created."
}</pre></div></div></div></section><section id="payments" data-ordernum="65"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text payments"><h1>Payments</h1><hr></hr><p>RevCent supports multiple payment types including check, credit card, offline and PayPal. Depending on the payment type, different methods are supported.<br><br>Additional payment types will be added in the future including Amazon Pay, Apply Pay and Google Pay.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="check-direct" data-ordernum="66"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text check-direct"><h2>Check Direct</h2><hr></hr><p>A check direct is considered a physical check, not ACH or electronic check. The physicality is what separates a check direct from electronic forms of check payments, along with the accounts receivable and mailing aspects. ACH and electronic check methods will be supported in the near future as a separate entity.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="check-direct-refund" data-ordernum="67"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text check-direct-refund"><h3>Check Direct Refund</h3><hr></hr><p>To refund a check direct you instead refund the entity that the refund is associated with, i.e. sale, product_sale, tax, shipping, etc.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="check-direct-retrieve" data-ordernum="68"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text check-direct-retrieve"><h3>Check Direct Retrieve</h3><hr></hr><p>Retrieve current information on a single check direct or multiple check directs.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_number<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The check number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">received<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the check has been received.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="check-direct-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "check_direct",
    "method": "retrieve",
    "id": "GO51EXbbAPS6pP1Ov9kK"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="check-direct-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "9rdXJQ5z4bcLYqLkV656",
  "api_call_processed": true,
  "api_call_unix": 1566160507,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "check_direct",
  "results": [
    {
      "amount": 201.58,
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "check_number": "",
      "created_date_unix": 1565832518,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "GO51EXbbAPS6pP1Ov9kK",
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "5r1MyL99VouMNRl9Pnkd",
        "d9ZolGRRwnu6lZb2Jo64",
        "WmPn2q99GzSKXWmbJjVd"
      ],
      "received": true,
      "sales": [
        "1rQAp8MM46uzN4Rw0Kgk"
      ],
      "salvage_transactions": [],
      "shipping": [
        "X8anGkNN5XfZK5mK06VX"
      ],
      "smtp_messages": [],
      "status": "Received",
      "subscription_renewals": [],
      "subscriptions": [
        "nbM1P5aa2VfNvVJvWjb1",
        "WmPn2q99GzSKRnQjZmkz"
      ],
      "tax": [
        "k6vn8JZZAmUv8G5z6klR"
      ],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop",
        "shop_url": "myshop.com"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1565832519
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="credit-card" data-ordernum="69"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text credit-card"><h2>Credit Card</h2><hr></hr><p>Credit card payments are supported via merchant gateway integrations. Integrate a merchant gateway within the RevCent web app. Once integrated you can conduct most payment actions, and RevCent updates transaction status to reflect payment settlement.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="transaction" data-ordernum="70"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text transaction"><h2>Transaction</h2><hr></hr><p>A credit card transaction can be two types, either a payment is captured, or a refund where a previous payment is refunded. RevCent only supports the auth-capture method when processing a payment, auth-only is not supported.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="transaction-create-refund" data-ordernum="71"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text transaction-create-refund"><h3>Transaction Create Refund</h3><hr></hr><p>Refund a credit card transaction directly. This is not the recommended method if you wish to run detailed metrics reports. Use either Product Sale Refund, Shipping Refund, or Subscription Renewal Refund instead.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the credit card transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount to refund. If not provided the entire transaction amount will be refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">refunded_offsite<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>You have the option to refund a credit card transaction within RevCent, without refunding the transaction at the gateway level. If set to true, RevCent will mark all entities as having a refund, but will not contact the gateway to return the money to the customer. This is useful for reporting within RevCent when a transaction was refunded outside of RevCent, i.e. Rapid Dispute Resolution, mailed a check, etc. Default is false.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">origin_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign ID of the transaction being refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">origin_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer ID of the transaction being refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">origin_sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sale ID of the transaction being refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">origin_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the transaction being refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each pending refund created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each product sale refunded as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">refunded_offsite<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the transaction was refunded using the refunded_offsite = true flag.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each shipping refunded as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each tax refunded as a result of the request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="transaction-create-refund-request" class="highlight-code language-json ">{
  "request": {
    "type": "transaction",
    "method": "create_refund",
    "transaction_id": "ALRjyqRE27fjMonyKLny",
    "refunded_offsite": false,
    "amount": 1.25
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="transaction-create-refund-response" class="highlight-code language-json ">{
  "amount": 1.25,
  "api_call_id": "0pwokmGgzRc0yg8dXp7q",
  "api_call_processed": true,
  "api_call_unix": 1565814903,
  "code": 1,
  "origin_campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "origin_customer_id": "4r158EzJmmcVM69dNLkg",
  "origin_sale_id": "k6vnbJom00Ug89mpRj78",
  "origin_transaction_id": "ALRjyqRE27fjMonyKLny",
  "pending_refund": [
    "MW5LoAVymnHww96XllEr",
    "vEwWrAjn8RcM9yQdyjOy",
    "9rdEMaP59RuYg41zRJwW",
    "Nk5voyEw8YiOmaRvjgyG"
  ],
  "product_sale_refunded": [
    "LY5yop5nk7hbPzpBn8aY",
    "9rdEMadyZ7uYgnbKWwX5"
  ],
  "refunded_offsite": false,
  "request_method": "create_refund",
  "request_type": "transaction",
  "result": "Pending refund created for transaction.",
  "shipping_refunded": [
    "gYamRbaGZphKn8zJVow1"
  ],
  "tax_refunded": [
    "ALRjyqRE27fjjpmRzBRd"
  ]
}</pre></div></div></div></section><section id="transaction-retrieve" data-ordernum="72"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text transaction-retrieve"><h3>Transaction Retrieve</h3><hr></hr><p>Retrieve current information on a single transaction or multiple transactions. You can use the RevCent ID or gateway transaction id as the id value when retrieving a single transaction.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the transaction or the gateway transaction ID of the transaction. Required if multiple property equals false and email property not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any refunds.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_settled<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount settled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_void<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any items that have been voided.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">approved<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction was approved.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">captured<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction was captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer credit card associated with the transaction.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card type</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_4<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last four digits of the credit card.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_month<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">expiry_year<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p></p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction was declined.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details_last_updated_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when RevCent requested details on the transaction status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The latest response from the merchant gateway when RevCent requested details on the transaction status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">error<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction had an error.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">has_salvage<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction has an associated salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">held<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction was held.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_payment_profile<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction is part of a payment profile request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_refund<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction is a refund transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_salvage<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction is a salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_subscription<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction is a subscription transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_subscription_renewal<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction is a subscription renewal transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Payment profile related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result of the transaction request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_initial<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction is an initial sale transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">settled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction has been settled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the subscription profile associated with the subscription.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the number of renewals allowed is specific or indefinite.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>If occurrences = specific, then the number of occurrence allowed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_specific<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription profile is specific to a single subscription. I.e. customized.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the subscription profile is specific to a single subscription, the subscription ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency setting. Either unit, calendar or fiscal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_unit<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unit based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">unit_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit value.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit, i.e. days, weeks, months or years.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_calendar<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar unit, i.e. The 2nd X of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar value, i.e. The X day of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_parent<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar parent, i.e. The 2nd day of every X</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_fiscal<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">void<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the transaction is void.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="transaction-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "transaction",
    "method": "retrieve",
    "id": "ALRjyqRE27fjMonyKLny"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="transaction-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "o1jGw57PVgFLLMJ8VJW7",
  "api_call_processed": true,
  "api_call_unix": 1565814903,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "transaction",
  "results": [
    {
      "amount": 111.86,
      "amount_captured": 111.86,
      "amount_fees": 3.02,
      "amount_gross": 111.86,
      "amount_net": 108.84,
      "amount_original_total": 111.86,
      "amount_refunded": 0,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_total": 111.86,
      "amount_void": 0,
      "approved": true,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "captured": true,
      "check_directs": [],
      "code": 1,
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "customer_card": {
        "type": "visa",
        "id": "1rQA58w6XXcMNRApYLPn",
        "last_4": "4242",
        "created_date_unix": 1565814899,
        "updated_date_unix": 1565814901,
        "expiry_date": "11/2023",
        "expiry_month": "11",
        "expiry_year": "2023"
      },
      "declined": false,
      "details_last_updated_unix": null,
      "details_response": "",
      "discounts": [],
      "error": false,
      "gateway_id": "NkAMJOzpB5iEAOrdloV0",
      "gateway_name": "Braintree",
      "has_salvage": true,
      "held": false,
      "id": "ALRjyqRE27fjMonyKLny",
      "is_payment_profile": false,
      "is_refund": false,
      "is_salvage": false,
      "is_subscription": false,
      "is_subscription_renewal": false,
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_profile": {
        "id": "ajyXm76OpjSL4p5oO2By",
        "name": "AuthBrainStripe",
        "results": null
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "9rdEMadyZ7uYgnbKWwX5",
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "result": "Approved",
      "sale_initial": true,
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "settled": false,
      "shipping": [
        "gYamRbaGZphKn8zJVow1"
      ],
      "smtp_messages": [],
      "status": "Fully Captured",
      "subscription_profile": null,
      "subscription_renewals": [],
      "subscriptions": [
        "o1jGw5jY2RILLl4dBMwa"
      ],
      "tax": [
        "ALRjyqRE27fjjpmRzBRd"
      ],
      "third_party_shop": null,
      "trials": [],
      "updated_date_unix": 1565814901,
      "void": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="transaction-search" data-ordernum="73"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text transaction-search"><h3>Transaction Search</h3><hr></hr><p>Search for a transaction using a string or group of strings.<br> Please read more about <a href="https://kb.revcent.com/en/integrations/revcent-api/api-search" target="_blank">API Search <i class="far fa-external-link-square-alt small"></i></a> before proceeding.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">search_term<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The string to search.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">item_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_6<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_4<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction ID assigned by the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">approved<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fingerprint<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">highlights<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">field<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">values<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">score<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="transaction-search-request" class="highlight-code language-json ">{
  "request": {
    "type": "transaction",
    "method": "search",
    "search_term": "424242 4242"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="transaction-search-response" class="highlight-code language-json ">{
  "api_call_id": "d9gW26qJVVurkPWX4nBb",
  "api_call_processed": true,
  "api_call_unix": 1681160220,
  "code": 1,
  "request_type": "transaction",
  "request_method": "search",
  "results": [
    {
      "item_type": "transaction",
      "id": "1rBrrKwjbVH885Jb078K",
      "created_date_unix": 1680909459,
      "customer_id": "gYQYYJlMXYHXXL709WlR",
      "first_name": "George",
      "last_name": "Washington",
      "email": "xbim32@gmail.com",
      "card_id": "wLvLLNmgJLH11GZ4qNdZ",
      "first_6": "400000",
      "last_4": "0002",
      "gateway_transaction_id": "60214190393",
      "request_type": "sale",
      "request_method": "create",
      "approved": true,
      "metadata": [],
      "url": "https://revcent.com/user/transaction-details/1rBrrKwjbVH885Jb078K",
      "highlights": [
        {
          "field": "gateway_transaction_id",
          "values": [
            "60214190393"
          ]
        }
      ],
      "score": 7.79
    }
  ]
}</pre></div></div></div></section><section id="offline-payment" data-ordernum="74"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text offline-payment"><h2>Offline Payment</h2><hr></hr><p>An offline payment is essentially a cash or any other means of exchange which needs to be recorded. Offline payments are also useful during replacements, rebates, etc.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="offline-payment-refund" data-ordernum="75"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text offline-payment-refund"><h3>Offline Payment Refund</h3><hr></hr><p>To refund an offline payment you instead refund the entity that the refund is associated with, i.e. sale, product_sale, tax, shipping, etc.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="offline-payment-retrieve" data-ordernum="76"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text offline-payment-retrieve"><h3>Offline Payment Retrieve</h3><hr></hr><p>Retrieve current information on a single offline payment or multiple offline payments.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the offline payment is related to a third party integration, such as Sezzle, Afterpay, etc.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the user third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the user third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details of the actual third party responsible for the offline payment.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the third party.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the third party.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="offline-payment-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "offline_payment",
    "method": "retrieve",
    "id": "zGldyKJGORfkP1O1vJ4B"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="offline-payment-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "gYagkq56lAsJn0K98Y4M",
  "api_call_processed": true,
  "api_call_unix": 1566160508,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "offline_payment",
  "results": [
    {
      "amount": 255.92,
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "Twitter Campaign",
      "check_directs": [],
      "created_date_unix": 1565830657,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [
        "6r1EpBQrbRCz91q8E6qb"
      ],
      "id": "zGldyKJGORfkP1O1vJ4B",
      "notes": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "BvwOk6VvpEs17GrozWaa",
        "gYamd2VYr9h4M5zOE7zN",
        "o1jGQnO1m4iQWpYjNaB6"
      ],
      "sales": [
        "4r15pjKr4RCraznBnvZ1"
      ],
      "salvage_transactions": [],
      "shipping": [
        "qZBAQK9Zabf4KgXRPmvA"
      ],
      "smtp_messages": [],
      "status": "Complete",
      "subscription_renewals": [],
      "subscriptions": [
        "Kn51QPBnE9iGE5mmBRqA"
      ],
      "tax": [
        "bOBywapOAGtjzk9PjWyd"
      ],
      "third_party_integration": {
        "id": "Q4l9bmQvLVCW72AmEZEg",
        "name": "My Sezzle Integration",
        "third_party": {
          "id": "6rlY0B40mVfzVXmL1yyP",
          "name": "Sezzle"
        }
      },
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop",
        "shop_url": "myshop.com"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1565830657
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="paypal" data-ordernum="77"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text paypal"><h2>PayPal</h2><hr></hr><p>Integrate your PayPal account(s) with RevCent using the web app and PayPal API credentials. Integrating PayPal with RevCent has several benefits, including dispute detection. PayPal payments made via third party shops and hosted pages are automatically integrated within RevCent.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="paypal-dispute" data-ordernum="78"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text paypal-dispute"><h2>PayPal Dispute</h2><hr></hr><p>Once you have integrated your PayPal account with RevCent, we will continuously monitor your PayPal account for any disputes.<br><br>RevCent will create a dispute item when a new dispute is found, and attempt to link the specific dispute to a known PayPal transaction within RevCent. Dispute action must be taken within PayPal. We do plan, in the future, to add the ability to take action within RevCent.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="paypal-dispute-retrieve" data-ordernum="79"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text paypal-dispute-retrieve"><h3>PayPal Dispute Retrieve</h3><hr></hr><p>Retrieve current information on a single PayPal dispute or multiple PayPal disputes.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_account<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal account you integrated with RevCent.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_account_email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The email address within PayPal for this specific account.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_details_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The exact API response RevCent received regarding the PayPal dispute.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_dispute_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount disputed, from paypal_details_response.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_dispute_created_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the dispute was created within PayPal, from paypal_details_response</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_dispute_created_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the dispute was created within PayPal, from paypal_details_response</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_dispute_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal dispute ID, from paypal_details_response</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_dispute_outcome<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Dispute outcome, from paypal_details_response</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_dispute_updated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The date the dispute was last updated within PayPal, from paypal_details_response.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_dispute_updated_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the dispute was last updated within PayPal, from paypal_details_response.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>PayPal messages, from paypal_details_response.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">posted_by<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_posted<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">content<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_reason<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The dispute reason, from paypal_details_response.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The status within PayPal, from paypal_details_response.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="paypal-dispute-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "paypal_dispute",
    "method": "retrieve",
    "id": "wLzYlmJdqGiM0RlvvLKp"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="paypal-dispute-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "ZVE5YRjd7RsXdJmN02pp",
  "api_call_processed": true,
  "api_call_unix": 1566160506,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "paypal_dispute",
  "results": [
    {
      "created_date_unix": 1565956199,
      "id": "wLzYlmJdqGiM0RlvvLKp",
      "paypal_account": {
        "id": "mJVWkmzVz0i42j0GEVK4",
        "name": "My PayPal Account",
        "paypal_account_email": "myemail@gmail.com"
      },
      "paypal_details_response": "",
      "paypal_dispute_amount": 89.98,
      "paypal_dispute_created_date": "2019-08-16T09:27:24+00:00",
      "paypal_dispute_created_date_unix": 1565947644,
      "paypal_dispute_id": "PP-D-XXXXXXXXX",
      "paypal_dispute_outcome": "",
      "paypal_dispute_updated_date": "2019-08-16T10:31:35+00:00",
      "paypal_dispute_updated_date_unix": 1565951495,
      "paypal_messages": [
        {
          "posted_by": "BUYER",
          "time_posted": "2019-08-16T09:27:30.000Z",
          "content": "Did not receive product."
        }
      ],
      "paypal_reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED",
      "paypal_status": "OPEN",
      "updated_date_unix": 1566129063
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="paypal-transaction" data-ordernum="80"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text paypal-transaction"><h2>PayPal Transaction</h2><hr></hr><p>A PayPal transaction is created within RevCent when a PayPal sale takes place via shopping cart plugin or a RevCent hosted page. RevCent confirms all transactions with PayPal and receives transaction details via the PayPal API.<br><br>RevCent also monitors your PayPal account for disputes, and will link disputes to existing transactions when detected.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="paypal-transaction-refund" data-ordernum="81"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text paypal-transaction-refund"><h3>PayPal Transaction Refund</h3><hr></hr><p>To refund a PayPal transaction you instead refund the entity that the refund is associated with, the same as you would a credit card transaction. Refunding a sale, shipping, or tax will automatically refund any PayPal transactions using the PayPal API.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="paypal-transaction-retrieve" data-ordernum="82"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text paypal-transaction-retrieve"><h3>PayPal Transaction Retrieve</h3><hr></hr><p>Retrieve current information on a single PayPal transaction or multiple PayPal transactions.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any refunds.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>PayPal transactions do not receive an amount_remaining, as they are considered complete when created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_settled<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>PayPal transactions do not receive an amount_settled, as they are considered complete when created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_account<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal account you integrated with RevCent.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_account_email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The email address within PayPal for this specific account.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_customer_id<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer ID within PayPal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction amount within PayPal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction date within PayPal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction unix timestamp within PayPal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal transaction ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="paypal-transaction-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "paypal_transaction",
    "method": "retrieve",
    "id": "k6omOdKbrRTZnpP6d7Ng"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="paypal-transaction-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "4r1ZLyqwrvcq9qLbA0qo",
  "api_call_processed": true,
  "api_call_unix": 1566160506,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "paypal_transaction",
  "results": [
    {
      "amount_captured": 0.01,
      "amount_fees": 0,
      "amount_gross": 0.01,
      "amount_net": 0.01,
      "amount_original_total": 0.01,
      "amount_refunded": 0,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_total": 0.01,
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "Twitter Campaign",
      "check_directs": [],
      "created_date_unix": 1562082423,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "k6omOdKbrRTZnpP6d7Ng",
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "paypal_account": {
        "id": "mJVWkmzVz0i42j0GEVK4",
        "name": "My PayPal Account",
        "paypal_account_email": "myemail@gmail.com"
      },
      "paypal_customer_id": null,
      "paypal_transaction_amount": 0.01,
      "paypal_transaction_date": "2019-07-02T15:46:58+00:00",
      "paypal_transaction_date_unix": 1562082418,
      "paypal_transaction_id": "XXXXXXXXXXXX",
      "pending_refunds": [
        "vEn8K4MKavIRAyw0NVbR"
      ],
      "product_sales": [
        "7rgo91jKVmtYk8NBnnNm"
      ],
      "sales": [
        "MWymZv5d6bSpQLl1ARMm"
      ],
      "salvage_transactions": [],
      "shipping": [
        "qZ4vKalGg5tv298VvO8V"
      ],
      "smtp_messages": [],
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1562082510
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="pending-refund" data-ordernum="83"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text pending-refund"><h2>Pending Refund</h2><hr></hr><p>All credit card transactions, paypal transactions, checks and offline payments create a pending refund when refunded. RevCent automatically processes a pending refund once a credit card transaction has settled with the merchant gateway.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="pending-refund-process" data-ordernum="84"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text pending-refund-process"><h3>Pending Refund Process</h3><hr></hr><p>Manually process a pending refund. This is not recommended, as RevCent will process pending refunds automatically. The response JSON is useful for notification events sent to endpoints.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The raw response of the gateway request as a result of the refund if original payment was via Credit Card.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">origin_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the transaction being refunded if original payment was via Credit Card.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The raw response of the PayPal request as a result of the refund if original payment was via PayPal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the PayPal transaction the refunded if original payment was via PayPal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the pending refund being processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the transaction created as a result of the refund if original payment was via Credit Card.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="pending-refund-process-request" class="highlight-code language-json ">{
  "request": {
    "type": "pending_refund",
    "method": "process",
    "id": "8rRNgQd0NGUv6Ggn7og0"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="pending-refund-process-response" class="highlight-code language-json ">{
  "amount": 9.35,
  "api_call_id": "wLRrX7jbJrI8R89jg8Bq",
  "api_call_unix": 1631302671,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "georgew@whitehouse.com",
    "enabled": true,
    "first_name": "George",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "pres_0001",
    "last_name": "Washington",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "gateway_raw_response": "",
  "origin_transaction_id": "2rRG9OBOjmf7pO8LV6Mq",
  "pending_refund_id": "8rRNgQd0NGUv6Ggn7og0",
  "request_method": "process",
  "request_type": "pending_refund",
  "result": "Pending refund processed successfully. Origin transaction refunded.",
  "transaction_id": "BvEPbYWrNBH9R9W1B95W"
}</pre></div></div></div></section><section id="pending-refund-retrieve" data-ordernum="85"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text pending-refund-retrieve"><h3>Pending Refund Retrieve</h3><hr></hr><p>Retrieve current information on a single pending refund or multiple pending refunds.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_check_direct<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the item was created using a check_direct payment method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_offline_payment<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the item was created using an offline payment method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the pending refund has been processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">refund_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card transaction ID being refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card refund transaction ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="pending-refund-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "pending_refund",
    "method": "retrieve",
    "id": "MW5LoAVymnHww96XllEr"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="pending-refund-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "bOBy95a444sy46EMwBj1",
  "api_call_processed": true,
  "api_call_unix": 1565814904,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "pending_refund",
  "results": [
    {
      "amount": 0.89,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1565814903,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "gateway_id": "NkAMJOzpB5iEAOrdloV0",
      "gateway_name": "Braintree",
      "id": "MW5LoAVymnHww96XllEr",
      "is_check_direct": false,
      "is_offline_payment": false,
      "live_mode": false,
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "processed": false,
      "product_sales": [
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "refund_transaction_id": "ALRjyqRE27fjMonyKLny",
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "shipping": [],
      "smtp_messages": [],
      "status": "Processing",
      "subscription_renewals": [],
      "subscriptions": [],
      "success_transaction_id": null,
      "tax": [],
      "trials": [],
      "updated_date_unix": 1565814903
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="product" data-ordernum="86"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product"><h2>Product</h2><hr></hr><p>Create, edit, enable, disable and delete products using the RevCent API. Keep product details and other information up to date.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="product-create" data-ordernum="87"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-create"><h3>Product Create</h3><hr></hr><p>Create a product via the product create method.<br><br><strong class="text-danger">Important:</strong> RevCent will always create a new product. RevCent will not match sku, internal_id or other identifier to check for existing products in order to prevent duplicates. If you wish to modify a product that already exists in RevCent, use the Product > Edit method below.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object, containing the actual product and its attributes.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">brand<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product brand. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is enabled, i.e. available for purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_child_product<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a child product of a parent product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">parent_product<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_group<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to contain the product within one or more RevCent product groups. Provide the RevCent ID(s) of each product group.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_bundle_product<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the product is a bundle consisting of individual bundled products. <a href="https://kb.revcent.com/en/product/product-bundle" target="_blank">Read More</a></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bundle_settings<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The bundle settings, specifying the bundled products and unbundle method. Bundled products total must equal product price. <a href="https://kb.revcent.com/en/product/product-bundle#selecting-bundled-products" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">products<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual products within the main bundle product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the bundled product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity of the bundled product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price of the bundled product.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unbundle_method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unbundle method. <a href="https://kb.revcent.com/en/product/product-bundle#unbundle-methods" target="_blank">Read More</a> <ul><li><strong>unbundle_at_fulfillment</strong>: When a sale request is received, the bundle product is not unbundled yet, and is instead processed as a single product.</li> <li><strong>unbundle_at_sale</strong>: When a sale request is received, the bundle product is unbundled and replaced by each product contained in the bundle.</li></ul> </p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_price_sale<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is currently on sale. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product price. Default price to be charged upon purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_trial<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product trial price. Price to charge when the trial ends, if different from initial sale price.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_subscription<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the subscription renewal price is different from initial sale price</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_sale<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">stock<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Current available stock. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">in_stock<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is currently in stock. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product cost. For profit calculations.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">msrp<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product MSRP. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rating_value<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rating value of the product. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">review_count<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of reviews. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">condition<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product condition. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An internal ID for the product. Can be used as an identifier for sale creation</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product SKU. Can be used as an identifier for sale creation.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">upc<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product UPC. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ean<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product EAN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">isbn<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product ISBN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">asin<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product ASIN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">mpn<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product MPN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_quantity_allowed<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_days<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Trial duration in days. This will create a trial for the product and not charge the customer until the trial ends.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_shipping_setting<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If this is a shippable product, specify when to ship the product. Accepted values:<br><dl class="dl-horizontal"><dt title="trial_expiration">trial_expiration</dt><dd>Product will only ship upon trial expiration.</dd><dt title="trial_creation">trial_creation</dt><dd>Product will only ship when the trial is created.</dd><dt title="both_trial_expiration_creation">both_trial_expiration_creation</dt><dd>Product will ship when trial is created and trial expiration.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If this is a subscription product, provide the ID of the subscription profile to use for recurring billing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is specific to a third party shop provide the ID of the third party shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_shippable<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a shippable product. A shipping entry will be created when the product is sold.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_attributes<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping attributes specific to the product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">weight<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product weight in lbs. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">length<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product length in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">width<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product width in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">height<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product height in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fulfillment_account<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fulfillment account for this product, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">additional_id<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Additional custom IDs for the specific product as name value pairs. Useful when the same product is sold via multiple channels with a different ID for each channel.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A description of the ID, not used as the additional ID or identifier when creating a sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The actual additional ID, used to identify a specific product.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="product-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "product",
    "method": "create",
    "product": {
      "name": "New Product",
      "description": "New product description.",
      "enabled": true,
      "sku": "new_product_sku",
      "url": "https://mystore.com/new-product-1",
      "internal_id": "new_product_internal_id",
      "price": 199.99,
      "price_trial": 199.99,
      "price_subscription": 199.99,
      "trial_shipping_setting": "both_trial_expiration_creation",
      "trial_days": 5,
      "is_shippable": true,
      "shipping_attributes": {
        "rate": "",
        "weight": "",
        "length": "",
        "width": "",
        "height": "",
        "fulfillment_account": "j0o25b2YJRFdJb8EEXE1"
      },
      "additional_id": [
        {
          "name": "another_id",
          "value": "id_123"
        }
      ],
      "subscription_profile": "d9NXVR62vGfYMw6VEZOl",
      "product_group": [
        "EMYlAaXA1yfkWWora9rG"
      ],
      "third_party_shop": "2rgA7J9AN8CMEpaQGPqN",
      "is_bundle_product": true,
      "bundle_settings": {
        "products": [
          {
            "id": "k6EXjKzd7PHOpgvdYjXG",
            "quantity": 1,
            "price": 100
          },
          {
            "id": "6r8O5MLbw2t6n4v1lGqK",
            "quantity": 1,
            "price": 99.99
          }
        ],
        "unbundle_method": "unbundle_at_sale"
      }
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="product-create-response" class="highlight-code language-json ">{
  "api_call_id": "EMwJyj8bdEfX9YwmR2EW",
  "api_call_processed": true,
  "api_call_unix": 1565814920,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "product_name": "New Product",
  "request_method": "create",
  "request_type": "product",
  "result": "Created new product."
}</pre></div></div></div></section><section id="product-edit" data-ordernum="88"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-edit"><h3>Product Edit</h3><hr></hr><p>Edit an existing product in RevCent by providing the RevCent ID of the product via the product_id property. The product object is the same as in the Product > Create request.<br><br>Note: Only properties included in the edit request will be modified for the product within RevCent. For instance, if you only wanted to modify the price, simply include only the price property in the edit request product object. </p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object, containing the actual product and its attributes.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">brand<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product brand. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is enabled, i.e. available for purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_child_product<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a child product of a parent product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">parent_product<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_group<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to contain the product within one or more RevCent product groups. Provide the RevCent ID(s) of each product group.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_bundle_product<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the product is a bundle consisting of individual bundled products. <a href="https://kb.revcent.com/en/product/product-bundle" target="_blank">Read More</a></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bundle_settings<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The bundle settings, specifying the bundled products and unbundle method. Bundled products total must equal product price. <a href="https://kb.revcent.com/en/product/product-bundle#selecting-bundled-products" target="_blank">Read More</a></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">products<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual products within the main bundle product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the bundled product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity of the bundled product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price of the bundled product.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unbundle_method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unbundle method. <a href="https://kb.revcent.com/en/product/product-bundle#unbundle-methods" target="_blank">Read More</a><ul><li><strong>unbundle_at_fulfillment</strong>: When a sale request is received, the bundle product is not unbundled yet, and is instead processed as a single product.</li> <li><strong>unbundle_at_sale</strong>: When a sale request is received, the bundle product is unbundled and replaced by each product contained in the bundle.</li></ul></p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_price_sale<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is currently on sale. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product price. Default price to be charged upon purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_trial<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product trial price. Price to charge when the trial ends, if different from initial sale price.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_subscription<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the subscription renewal price is different from initial sale price</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_sale<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">stock<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Current available stock. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">in_stock<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is currently in stock. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product cost. For profit calculations.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">msrp<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product MSRP. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rating_value<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rating value of the product. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">review_count<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of reviews. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">condition<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product condition. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An internal ID for the product. Can be used as an identifier for sale creation</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product SKU. Can be used as an identifier for sale creation.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">upc<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product UPC. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ean<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product EAN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">isbn<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product ISBN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">asin<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product ASIN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">mpn<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product MPN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_quantity_allowed<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_days<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Trial duration in days. This will create a trial for the product and not charge the customer until the trial ends.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_shipping_setting<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If this is a shippable product, specify when to ship the product. Accepted values:<br><dl class="dl-horizontal"><dt title="trial_expiration">trial_expiration</dt><dd>Product will only ship upon trial expiration.</dd><dt title="trial_creation">trial_creation</dt><dd>Product will only ship when the trial is created.</dd><dt title="both_trial_expiration_creation">both_trial_expiration_creation</dt><dd>Product will ship when trial is created and trial expiration.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If this is a subscription product, provide the ID of the subscription profile to use for recurring billing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is specific to a third party shop provide the ID of the third party shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_shippable<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a shippable product. A shipping entry will be created when the product is sold.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_attributes<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping attributes specific to the product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">weight<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product weight in lbs. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">length<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product length in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">width<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product width in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">height<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product height in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fulfillment_account<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fulfillment account for this product, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">additional_id<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Additional custom IDs for the specific product as name value pairs. Useful when the same product is sold via multiple channels with a different ID for each channel.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A description of the ID, not used as the additional ID or identifier when creating a sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The actual additional ID, used to identify a specific product.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="product-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "product",
    "method": "edit",
    "product_id": "qZBAz5nL0RfBgpgg2r49",
    "product": {
      "max_quantity_allowed": 2,
      "subscription_profile": "d9NXVR62vGfYMw6VEZOl",
      "shipping_attributes": {
        "fulfillment_account": "j0o25b2YJRFdJb8EEXE1"
      },
      "name": "My Awesome Product",
      "description": "My awesome product description",
      "url": "https://mystore.com/my-awesome-product",
      "price": 199.99,
      "price_trial": 199.99,
      "price_subscription": 199.99,
      "trial_shipping_setting": "both_trial_expiration_creation",
      "trial_days": 3,
      "enabled": true,
      "is_shippable": true,
      "is_bundle_product": true,
      "bundle_settings": {
        "products": [
          {
            "id": "k6EXjKzd7PHOpgvdYjXG",
            "quantity": 1,
            "price": 100
          },
          {
            "id": "6r8O5MLbw2t6n4v1lGqK",
            "quantity": 1,
            "price": 99.99
          }
        ],
        "unbundle_method": "unbundle_at_sale"
      }
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="product-edit-response" class="highlight-code language-json ">{
  "api_call_id": "VPm9MqdqLzUJJ1GNdyqR",
  "api_call_processed": true,
  "api_call_unix": 1565814921,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "request_method": "edit",
  "request_type": "product",
  "result": "Product successfully modified."
}</pre></div></div></div></section><section id="product-enable" data-ordernum="89"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-enable"><h3>Product Enable</h3><hr></hr><p>Enable a product which has been previously disabled.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product ID</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="product-enable-request" class="highlight-code language-json ">{
  "request": {
    "type": "product",
    "method": "enable",
    "product_id": "qZBAz5nL0RfBgpgg2r49"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="product-enable-response" class="highlight-code language-json ">{
  "api_call_id": "ZVEGoylyMacZZ1XkLX1M",
  "api_call_processed": true,
  "api_call_unix": 1565814921,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "request_method": "enable",
  "request_type": "product",
  "result": "Product successfully enabled."
}</pre></div></div></div></section><section id="product-disable" data-ordernum="90"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-disable"><h3>Product Disable</h3><hr></hr><p>Disable a product, not allowing it to be included in a sale.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product ID</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="product-disable-request" class="highlight-code language-json ">{
  "request": {
    "type": "product",
    "method": "disable",
    "product_id": "qZBAz5nL0RfBgpgg2r49"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="product-disable-response" class="highlight-code language-json ">{
  "api_call_id": "YaVqjAdAG8tGGYALrzMg",
  "api_call_processed": true,
  "api_call_unix": 1565814921,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "request_method": "disable",
  "request_type": "product",
  "result": "Product successfully disabled."
}</pre></div></div></div></section><section id="product-delete" data-ordernum="91"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-delete"><h3>Product Delete</h3><hr></hr><p>Delete a product from RevCent. We highly recommend you do not use this method if the product has existing sales, subscriptions, etc. associate with it.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product ID</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="product-delete-request" class="highlight-code language-json ">{
  "request": {
    "type": "product",
    "method": "delete",
    "product_id": "qZBAz5nL0RfBgpgg2r49"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="product-delete-response" class="highlight-code language-json ">{
  "api_call_id": "bOBy95E8awiypP4046jm",
  "api_call_processed": true,
  "api_call_unix": 1565814922,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "request_method": "delete",
  "request_type": "product",
  "result": "Product successfully deleted."
}</pre></div></div></div></section><section id="product-retrieve" data-ordernum="92"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-retrieve"><h3>Product Retrieve</h3><hr></hr><p>Retrieve current information on a single product or multiple products.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">additional_id<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Additional custom IDs for the specific product as name value pairs. Useful when the same product is sold via multiple channels with a different ID for each channel.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A description of the ID, not used as the additional ID or identifier when creating a sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The actual additional ID, used to identify a specific product.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">asin<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product ASIN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">brand<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product brand. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bundle_settings<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The bundle settings, specifying the bundled products and unbundle method.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">products<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual products within the main bundle product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the bundled product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity of the bundled product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price of the bundled product.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unbundle_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unbundle method.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">condition<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product condition. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product cost. Will be used for future profit calculations.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ean<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product EAN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is enabled, i.e. available for purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent product ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">images<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product images. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">images_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product images url. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">in_stock<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is currently in stock. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>An internal ID for the product. Can be used as an identifier for sale creation</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_bundle_product<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the product is a bundle consisting of individual bundled products.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_child_product<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a child product of a parent product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_discount<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_price_sale<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is currently on sale. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_shippable<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a shippable product. A shipping entry will be created when the product is sold.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">isbn<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product ISBN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_quantity_allowed<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">mpn<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product MPN. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">msrp<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product MSRP. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">parent_product<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product price. Default price to be charged upon purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_sale<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_subscription<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the subscription renewal price is different from initial sale price</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price_trial<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product trial price. Price to charge when the trial ends, if different from initial sale price.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_group<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is contained within a product group, each product group will be displayed as an object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product group ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product group name.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rating_value<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The rating value of the product. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">review_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of reviews. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_attributes<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping attributes specific to the product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">weight<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product weight in lbs. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">length<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product length in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">width<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product width in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">height<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product height in inches. For upcoming search engine and shipping cost integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fulfillment_account<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fulfillment account for this product, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fulfillment account ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fulfillment account name.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_profile<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product SKU. Can be used as an identifier for sale creation.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">stock<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>Current available stock. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the subscription profile associated with the subscription.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the number of renewals allowed is specific or indefinite.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>If occurrences = specific, then the number of occurrence allowed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_specific<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription profile is specific to a single subscription. I.e. customized.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the subscription profile is specific to a single subscription, the subscription ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency setting. Either unit, calendar or fiscal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_unit<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unit based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">unit_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit value.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit, i.e. days, weeks, months or years.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_calendar<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar unit, i.e. The 2nd X of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar value, i.e. The X day of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_parent<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar parent, i.e. The 2nd day of every X</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_fiscal<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_days<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>Trial duration in days.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_shipping_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If this is a shippable product, specify when to ship the product. Accepted values:<br><dl class='dl-horizontal'><dt title='trial_expiration'>trial_expiration</dt><dd>Product will only ship upon trial expiration.</dd><dt title='trial_creation'>trial_creation</dt><dd>Product will only ship when the trial is created.</dd><dt title='both_trial_expiration_creation'>both_trial_expiration_creation</dt><dd>Product will ship when trial is created and trial expiration.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">upc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product UPC. For upcoming search engine integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="product-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "product",
    "method": "retrieve",
    "id": "qZBAz5nL0RfBgpgg2r49"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="product-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "bOBy95m1E7TypJ7X2lvL",
  "api_call_processed": true,
  "api_call_unix": 1565814920,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "product",
  "results": [
    {
      "additional_id": [
        {
          "name": "another_id",
          "value": "id_123"
        }
      ],
      "asin": "",
      "brand": "",
      "bundle_settings": {
        "products": [
          {
            "id": "k6EXjKzd7PHOpgvdYjXG",
            "name": "USB HDD",
            "quantity": 1,
            "price": 100
          },
          {
            "id": "6r8O5MLbw2t6n4v1lGqK",
            "name": "AV 2017",
            "quantity": 1,
            "price": 99.99
          }
        ],
        "unbundle_method": "unbundle_at_sale"
      },
      "condition": "",
      "cost": null,
      "created_date_unix": 1565814920,
      "description": "New product description.",
      "discount_rate": null,
      "ean": "",
      "enabled": true,
      "id": "qZBAz5nL0RfBgpgg2r49",
      "images": [],
      "images_url": "productimg.revcent.com",
      "in_stock": true,
      "internal_id": "An7W08XVj_internal_id",
      "is_bundle_product": true,
      "is_child_product": false,
      "is_discount": false,
      "is_price_sale": false,
      "is_shippable": true,
      "isbn": "",
      "max_quantity_allowed": 0,
      "metadata": [],
      "mpn": "",
      "msrp": null,
      "name": "New Product",
      "parent_product": null,
      "price": 199.99,
      "price_sale": null,
      "price_subscription": 199.99,
      "price_trial": 199.99,
      "product_group": [
        {
          "id": "EMYlAaXA1yfkWWora9rG",
          "name": "My Product Group"
        }
      ],
      "rating_value": null,
      "review_count": null,
      "shipping_attributes": {
        "height": null,
        "width": null,
        "length": null,
        "weight": null,
        "rate": null,
        "fulfillment_account": {
          "id": "j0o25b2YJRFdJb8EEXE1",
          "name": "ShipWorks"
        },
        "shipping_profile": null
      },
      "sku": "new_product_sku",
      "stock": 0,
      "subscription_profile": {
        "id": "LYE26aKJpPi5VbJmlp2A",
        "name": "Monthly",
        "description": "",
        "occurrences": "specific",
        "occurrences_value": 3,
        "subscription_specific": false,
        "subscription_id": null,
        "frequency_unit": {
          "unit_value": 1,
          "unit": "months"
        },
        "frequency_calendar": {},
        "frequency_fiscal": {},
        "frequency": "unit"
      },
      "third_party_shop": null,
      "trial_days": 5,
      "trial_shipping_setting": "both_trial_expiration_creation",
      "upc": "",
      "url": "https://mystore.com/new-product-1",
      "updated_date_unix": 1565814920
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="product-sale" data-ordernum="93"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-sale"><h2>Product Sale</h2><hr></hr><p>A product sale is a sale on a per product basis. This allows us to provide advanced metrics on a product specific level.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="product-sale-refund" data-ordernum="94"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-sale-refund"><h3>Product Sale Refund</h3><hr></hr><p>If you wish to void a product sale simply leave out the amount property in the request. If you wish to partially refund a product sale then include the amount property with the value amount to refund. If including the entire product sale amount then it will be void automatically. It is important to note that if a product sale is voided it is irreversible.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sale ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount to refund. If not provided or blank the entire product sale amount will be refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cancel_sub_trial<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to cancel any subscription or trial associated with the product sale. Default is true.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each pending refund created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the product sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_cancelled<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of subscription IDs that were cancelled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_cancelled<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of trial IDs that were cancelled.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="product-sale-refund-request" class="highlight-code language-json ">{
  "request": {
    "type": "product_sale",
    "method": "refund",
    "product_sale_id": "zGld6plAkacWRzRwblaJ",
    "amount": 2.25
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="product-sale-refund-response" class="highlight-code language-json ">{
  "amount": 2.25,
  "api_call_id": "Kn51oqRdpbcyyEPpzQj5",
  "api_call_processed": true,
  "api_call_unix": 1565814910,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "pending_refund": [
    "BvwOyAod0NC221Z7A5mV"
  ],
  "product_sale_id": "zGld6plAkacWRzRwblaJ",
  "request_method": "refund",
  "request_type": "product_sale",
  "result": "Product sale refunded in the amount of $2.25.",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "subscription_cancelled": [],
  "trial_cancelled": []
}</pre></div></div></div></section><section id="product-sale-retrieve" data-ordernum="95"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text product-sale-retrieve"><h3>Product Sale Retrieve</h3><hr></hr><p>Retrieve current information on a single product sale or multiple product sales.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount discounted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any refunds.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_settled<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount settled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_void<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any items that have been voided.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="product-sale-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "product_sale",
    "method": "retrieve",
    "id": "zGld6plAkacWRzRwblaJ"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="product-sale-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "X8anMkRdEmcbbGM9Gmwr",
  "api_call_processed": true,
  "api_call_unix": 1565814910,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "product_sale",
  "results": [
    {
      "amount_captured": 149.99,
      "amount_discounted": 0,
      "amount_fees": 4.35,
      "amount_gross": 149.99,
      "amount_net": 145.64,
      "amount_original_total": 149.99,
      "amount_refunded": 0,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_to_salvage": 0,
      "amount_total": 149.99,
      "amount_void": 0,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "zGld6plAkacWRzRwblaJ",
      "internal_id": "robo_vac",
      "iso_currency": "USD",
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku",
        "name": "Robo Vac",
        "quantity": 1,
        "price": 149.99,
        "list_price": 149.99
      },
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Fully Captured",
      "subscription_renewals": [],
      "subscriptions": [
        "WmPnWqPKbpFRmy6Ma2BG"
      ],
      "tax": [
        "P65Gn2J15pc5KRdLp22w"
      ],
      "third_party_shop": null,
      "transactions": [
        "wLz5MAWPzoUW5VNlydoa"
      ],
      "trials": [
        "LY5yop5nk7hb6o2Pvl5j"
      ],
      "updated_date_unix": 1565814909
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="sale" data-ordernum="96"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale"><h1>Sale</h1><hr></hr><p>A sale is one or more products sold. Shipping and tax can be manually provided or automatically created depending on your request and account settings. Several payment types are supported including credit card, PayPal, check and offline payment.<br><br>You also have the ability to create a pending sale without initially specifying a payment type, which saves the sale information to be finalized later. Refer to the <a href="#sale-pending">Pending Sale</a> section.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="sale-create" data-ordernum="97"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-create"><h2>Sale Create</h2><hr></hr><p>Create a new sale using the sale create API call. This is an important API call and we recommend viewing all property descriptions for both the request and response objects. Request object properties have some nuances depending on the product(s) being sold, tracking, customer, etc. Response object properties are useful for displaying information to a customer sale immediately after a payment is made.<br><br>Note: Depending on the payment type being used for the sale, refer to the sections below for specific requirements and examples for <a href="#sale-create-credit-card">Credit Card</a>, <a href="#sale-create-paypal">PayPal</a>, <a href="#sale-create-check-direct">Check</a> and <a href="#sale-create-offline-payment">Offline</a> payment methods.<br><br></p><div class="alert alert-default"><p><strong>AdWords Integration</strong></p><p>If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID. Read more about integrating AdWords with RevCent on our <a href="https://kb.revcent.com/en/tracking/google-adwords" target="_blank">Knowledge Base <i class="far fa-external-link-square-alt small"></i></a>. </p><p><i>Example</i></p><pre>"metadata":[{"name": "adwords_click", "value": "ADWORDS_CLICK_ID_HERE"}]</pre></div><div class="alert alert-default"><p><strong>Kount Integration</strong></p><p>If you have setup Kount as a third party integration in RevCent, and wish to have Kount check the payment for fraud, include the "kount_session_id" object in your request metadata array. RevCent will detect the specific metadata object with name="kount_session_id" and perform the proper communication with Kount before sending the payment to the desired processor. Empty session IDs will result in an error from Kount. Read more about integrating Kount with RevCent on our <a href="https://kb.revcent.com/integrations/third-party/kount" target="_blank">Knowledge Base <i class="far fa-external-link-square-alt small"></i></a>.</p><p><i>Example</i></p><pre>"metadata":[{"name": "kount_session_id", "value": "KOUNT_SESSION_ID_HERE"}]</pre></div><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object. Multiple payment methods are accepted when creating a sale. However, each payment method has specific required fields.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">credit_card<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by credit card.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">card_code<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card code as a string. Depending on the card type this can be different lengths.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_number<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card number. This value must be a valid credit card number as a string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_month<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month. Two digit integer, MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_year<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year. Two digit integer, YY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">set_as_default<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by PayPal, and already processed by PayPal with a return transaction ID.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal transaction ID, provided by PayPal for the corresponding transaction.<br><br>PayPal payments are processed by PayPal and not RevCent, therefore RevCent needs the transaction ID to create a PayPal sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_account_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">force_transaction<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Default: false. RevCent verifies all PayPal transactions using the PayPal API before officially confirming the sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_direct<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is a physical check, not ACH or electronic.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">check_number<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">mail_to_address<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify the mailing address for a customer to mail the physical check to. Useful when utilizing SMTP messages containing customer instructions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pay_to_address<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify the pay to address for a customer to make the check out to. Useful when utilizing SMTP messages containing customer instructions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is in cash, etc., or it is necessary to create a sale without an actual payment type.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code. If not provided default is 'USD'.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bill_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the billing information. If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object receives first priority as details if creating a new customer.<br><br>If the customer object is not present the bill_to and ship_to objects will be used in the respective order.<br><br>If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.<br><br>This does not apply if using a customer_id field in the request where applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you are creating a sale for an existing customer. This value can be the RevCent customer ID or your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to create a unique sale request. This allows you to successfully retry a failed API call without risk of charging a customer twice for the same sale. If a sale has been paid it will not allow future payments to be processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to associate the sale with a third party shop provide the RevCent ID for the third party shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a payment profile for processing the item payment. This value can either be the RevCent payment profile ID or the custom payment profile name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_sale_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal sale ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product array contains individual product objects.<br><br>Pricing is automatically calculated based upon the quantity, price or both if present.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price, if different from the product default price, you wish to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity. Default is 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_end_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_days<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending after the number of days provided.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the shipping information. Any shipping entries created will use the ship_to object field.<br><br>If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping array. Can contain multiple shipping objects.<br><br><strong>Note:</strong> View our <a href="https://kb.revcent.com/en/revenue/shipping#provider-method-table" target="_blank">Provider Method Table <i class="small fa fa-fw fa-external-link"></i></a> for mapping provider and provider_method values for shipping object entries.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your shipping cost. This is for your internal purposes.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">free_shipping<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether you wish to internally identify this as a free shipping item. This value will NOT be used to calculate any amounts. This if for your internal purposes. Default: false</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tax array. Can contain multiple tax objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon array. Can contain multiple coupon objects, each containing a coupon code.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount array. Can contain multiple discount objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_value<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The actual discount value according to the discount type. Currently the discount value is a fixed amount, i.e. 5 will deduct the sale price by 5.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type. Default: amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount description.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount discounted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success<br>2 = Merchant Declined<br>3 = Merchant Error<br>4 = Merchant Hold<br>5 = Fraud Detected<br></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of discounts created as a result of the request.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the discount created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the discount created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total discount amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_percent<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The percentage of the total.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the discount created.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_response<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If fraud detection is active, the response from a detection request will be present. A fraud detection request is made prior to the payment attempt with the processor.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The request code. 1 = No fraud or no detection integrated. 5 = Fraud detected. 0 = Error.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">message<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The explained result of any fraud detection request related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detected<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether fraud was detected before processing the items' related payment.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Any fraud detections created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fraud_detection_request<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If fraud detection is integrated and a third party is contacted prior to payment, the details of a fraud detection request.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the specific third party.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the third party.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the third party.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_integration<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of your RevCent third party integration.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of your RevCent third party integration.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The raw response returned from the third party when originally contacted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_fraud_detection_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The third party ID for the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_response_ms<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The response time in milliseconds it took to receive a response from the third party integration.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The full response from the merchant gateway as a JSON string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal sale ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_results<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the payment profile used.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">original_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The original amount submitted in the request using the products, their prices and quantities.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">final_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The final amount that was successfully charged after the payment profile was applied, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step in the payment profile that ended in success, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway that successfully processed the transaction, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_declined_transactions<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of declined transactions that occurred when the payment profile was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_transaction_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of IDs for declined transactions during the payment profile processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step_array contains individual objects related to the number of steps taken in the process when implementing the payment profile.<br>We highly recommend you read more about the Payment Profile feature at RevCent to gain a better understanding of what steps are as well as step methods.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">step_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The action taken during the step.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The resulting step amount to be charged after any modifiers to payment amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_cascade_result<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of gateways used when processing the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled_gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateways which were enabled within the cascade for processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The results for each gateway validated within the cascade, after being passed or failed due to in place rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway validated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of the gateway within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all revenue rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were present and enabled, the results of the revenue validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all time rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were present and enabled, the results of the time validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all gateway validation requirements.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway which was selected first for validation.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The response returned by the gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The modifier applied to the payment amount, if any.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific step number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result of the step transaction</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step setting.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step source, either gateway or cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_transaction<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the step transaction.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of product sales created. Each object is an individual product sale containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount discounted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price of the product, either from product settings or if specific price provided in the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity submitted in the request, or 1 if quantity was not provided.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details if a subscription was created as a result of the product sale. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details if a trial was created as a result of the product sale. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quota_accounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If any products purchased were quota based, then a quota account will be created or modified if already exists for the customer.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quota account ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quota_unit_group<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quota unit group associated with the quota account.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quota unit group ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quota unit group name.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quota_account_units<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of quota unit balances within the quota account. Displays current balance for each unit.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quota unit ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quota unit name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">balance<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quota unit balance within the quota account after the api call was processed.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction details object, if created as a result of the request. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_creator<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction will create a new sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction_created<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a salvage transaction was created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ship to object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of shipping items created. Each object is an individual shipping item containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount discounted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking if provided.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">weight<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of subscriptions created. Each object is an individual subscription containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the subscription starts, either sale creation or when related trial is set to end.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">next_renewal_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the subscription next renews. Calcaulted on sale creation or null and ultimately calculated when trial ends.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details of the related product sale.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p></p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details if a trial was created related to the subscription. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of tax items created. Each object is an individual tax item containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate calculated based on tax amount and total related item amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the credit card transaction charged to create the sale, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of trials created. Each object is an individual trial containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_days<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial duration in number of days.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the trial is set to expire.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details of the related product sale.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details of any related subscription.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_account_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If any product(s) were a usage/metered billing product, then usage account(s) will be created for each related products' usage profile billing period. Same period billing will group items into one usage account</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The usage account ID.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_item_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If any product(s) were a usage/metered billing product, then usage item(s) will be created for each related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The usage item ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sale associated with the usage item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product associated with the usage item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial associated with the usage item, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">usage_account<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The usage account associated with the usage item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "create",
    "payment": {
      "credit_card": {
        "card_number": "4242424242424242",
        "exp_month": 4,
        "exp_year": 22,
        "card_code": "000"
      },
      "payment_type": "credit_card"
    },
    "campaign": "Adwords Campaign",
    "iso_currency": "USD",
    "payment_profile": "AuthBrainStripe",
    "customer": {
      "first_name": "George",
      "last_name": "Washington",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "george@whitehouse.gov",
      "phone": "1234567890"
    },
    "bill_to": {
      "first_name": "George",
      "last_name": "Washington",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "george@whitehouse.gov",
      "phone": "1234567890"
    },
    "ship_to": {
      "first_name": "George",
      "last_name": "Washington",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "george@whitehouse.gov",
      "phone": "1234567890"
    },
    "product": [
      {
        "id": "robo_vac",
        "quantity": 1
      },
      {
        "id": "av_2017",
        "price": 19.99
      },
      {
        "id": "usb_hdd"
      }
    ],
    "tax": [
      {
        "amount": 9.31,
        "rate": 7.3,
        "name": "State Sales",
        "description": "seven percent"
      }
    ],
    "shipping": [
      {
        "amount": 5,
        "name": "USPS Priority",
        "description": "",
        "provider": "usps",
        "provider_method": "priority",
        "provider_tracking": "3546 5214 5698 5214 5488  91",
        "weight": 4.3
      }
    ],
    "coupon": [
      {
        "coupon_code": "10percent"
      }
    ],
    "discount": [
      {
        "discount_value": 5,
        "discount_type": "amount",
        "name": "$5 Off manually applied",
        "description": "Manually applied discount."
      }
    ],
    "internal_sale_id": "sale_7678",
    "internal_customer_id": "cus_3197",
    "metadata": [
      {
        "name": "adwords_click",
        "value": "Cjat0KwhCQjdTq..."
      },
      {
        "name": "sign_up_page",
        "value": "v1"
      },
      {
        "name": "kount_session_id",
        "value": "c8ed4debf8f242be972c1071731052e8"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-create-response" class="highlight-code language-json ">{
  "amount": 111.86,
  "amount_captured": 111.86,
  "amount_discounted": 0,
  "amount_fees": 3.02,
  "amount_gross": 111.86,
  "amount_net": 108.84,
  "amount_original_total": 274.28,
  "amount_remaining": 162.42,
  "amount_to_salvage": 12.43,
  "api_call_id": "O051ZWQ4XjijnV5LkVGl",
  "api_call_processed": true,
  "api_call_unix": 1565833755,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "card_id": "WmPn2g8bakcKnWWEmRlJ",
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "georgew@whitehouse.com",
    "enabled": true,
    "first_name": "George",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "pres_0001",
    "last_name": "Washington",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "customer_id": "ajOAl24bBXc5nXwagAOg",
  "discount_created": [],
  "fraud_detection_response": {
    "code": 1,
    "message": "No fraud detected. Continuing payment.",
    "fraud_detected": false,
    "fraud_detection_created": null,
    "fraud_detection_request": {
      "id": "rmMrXO5G8EFk8zO0rGlX",
      "third_party": {
        "id": "mJEZdyVavzUL0gGoLR1Z",
        "name": "Kount"
      },
      "third_party_integration": {
        "id": "ajYRoLokyXf62qy06JpZ",
        "name": "Kount Risk Inquiry"
      },
      "third_party_raw_response": "",
      "third_party_order_id": "",
      "third_party_fraud_detection_id": "DWN40J2NPKRW",
      "third_party_response_ms": 834
    }
  },
  "gateway": "Braintree",
  "gateway_id": "NkAMJOzpB5iEAOrdloV0",
  "gateway_raw_response": "",
  "internal_customer_id": "cus_3197",
  "internal_sale_id": "sale_7678",
  "iso_currency": "USD",
  "payment_profile_results": {
    "payment_profile_id": "ajyXm76OpjSL4p5oO2By",
    "original_amount": 124.29,
    "final_amount": 111.86,
    "successful_step_num": 2,
    "successful_gateway": "Braintree",
    "num_declined_transactions": 1,
    "declined_transaction_array": [
      "RJ5MaZMap1cZdP9w7ayE"
    ],
    "step_array": [
      {
        "step_action": "initial",
        "step_amount": 124.29,
        "step_cascade_result": {
          "cascade_order": "sort_order",
          "enabled_gateways": [
            "2rE2pQGMd7SYjGp42yEL",
            "LYE26MW8Rlh5VbJmlp2l",
            "GOJankNpkpsPzw6No1OP",
            "NkAMJOzpB5iEAOrdloV0"
          ],
          "gateway_results": [
            {
              "gateway_id": "2rE2pQGMd7SYjGp42yEL",
              "order": 1,
              "revenue_rules": {
                "enabled": false,
                "passed": true,
                "details": []
              },
              "success": true,
              "time_rules": {
                "enabled": false,
                "passed": true,
                "details": []
              }
            }
          ],
          "start_gateway": "2rE2pQGMd7SYjGp42yEL"
        },
        "step_gateway": "Worldpay",
        "step_gateway_id": "2rE2pQGMd7SYjGp42yEL",
        "step_gateway_response": "",
        "step_modifier": "",
        "step_num": 1,
        "step_result": "Declined",
        "step_setting": "initial",
        "step_source": "cascade",
        "step_transaction": "RJ5MaZMap1cZdP9w7ayE"
      },
      {
        "step_action": "next",
        "step_amount": 111.86,
        "step_cascade_result": null,
        "step_gateway": "Braintree",
        "step_gateway_id": "NkAMJOzpB5iEAOrdloV0",
        "step_modifier": "10",
        "step_num": 2,
        "step_result": "Approved",
        "step_setting": "modifypct",
        "step_source": "gateway",
        "step_transaction": "vEwWZv5B5zIXM9bq1yQd"
      }
    ]
  },
  "product_sale_created": [
    {
      "amount_original_total": 89.99,
      "amount_captured": 79.82,
      "amount_gross": 79.82,
      "amount_net": 77.66,
      "amount_fees": 2.16,
      "amount_remaining": 10.17,
      "amount_to_salvage": 10.17,
      "amount_discounted": 0,
      "id": "8rwvAzd6dQU6kXkB2VQq",
      "price": 89.99,
      "quantity": 1,
      "product": {
        "id": "k6EXjKzd7PHOpgvdYjXG",
        "name": "USB HDD",
        "internal_id": "usb_hdd",
        "sku": "usb_hdd_sku"
      },
      "subscription": null,
      "trial": null
    },
    {
      "amount_original_total": 149.99,
      "amount_captured": 0,
      "amount_gross": 0,
      "amount_net": 0,
      "amount_fees": 0,
      "amount_remaining": 149.99,
      "amount_to_salvage": 0,
      "amount_discounted": 0,
      "id": "7rwyAzL5LXUa8QrGMoMR",
      "price": 149.99,
      "quantity": 1,
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "name": "Robo Vac",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku"
      },
      "subscription": {
        "id": "4r15qAlZlyUoMprMNVpE"
      },
      "trial": {
        "id": "k6vn81lElqsvKEB4K2JA"
      }
    },
    {
      "amount_original_total": 19.99,
      "amount_captured": 17.73,
      "amount_gross": 17.73,
      "amount_net": 17.25,
      "amount_fees": 0.48,
      "amount_remaining": 2.26,
      "amount_to_salvage": 2.26,
      "amount_discounted": 0,
      "id": "Nk5vOzGAGRfrmg8LZXVM",
      "price": 19.99,
      "quantity": 1,
      "product": {
        "id": "6r8O5MLbw2t6n4v1lGqK",
        "name": "AV 2017",
        "internal_id": "av_2017",
        "sku": "av_2017_sku"
      },
      "subscription": {
        "id": "VPm9vVEoERc6Wy6Jg7Jg"
      },
      "trial": null
    }
  ],
  "quota_accounts": [
    {
      "id": "4rybZlBnGyCk85zlMmGj",
      "quota_unit_group": {
        "id": "6rnQQzm2mkSmrAorQ6ym",
        "name": "Currency Tokens"
      },
      "quota_account_units": [
        {
          "id": "6rnmX4jmGjcvW6AGKrwJ",
          "name": "Silver Token",
          "balance": 50
        }
      ]
    }
  ],
  "request_method": "create",
  "request_type": "sale",
  "result": "Approved",
  "sale_id": "rm9EG1BjrXcqm64KKq6z",
  "salvage_transaction": {
    "id": "9rdE4zvXvQUjVp22ddgm",
    "amount": 12.43,
    "enabled": true,
    "sale_creator": false
  },
  "salvage_transaction_created": true,
  "ship_to": {
    "first_name": "George",
    "last_name": "Washington",
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "city": "Washington",
    "state": "DC",
    "zip": "20500",
    "company": "",
    "country": "USA",
    "email": "george@whitehouse.gov",
    "phone": "1234567890"
  },
  "shipping_created": [
    {
      "amount_original_total": 5,
      "amount_captured": 5,
      "amount_gross": 5,
      "amount_net": 4.87,
      "amount_fees": 0.14,
      "amount_remaining": 0,
      "amount_to_salvage": 0,
      "amount_discounted": 0,
      "id": "Q45o8zGpGRu098B88npR",
      "provider": "usps",
      "provider_method": "priority_mail_express_flat_rate_envelope",
      "provider_tracking": "3546 5214 5698 5214 5488  91",
      "weight": 0
    }
  ],
  "subscription_created": [
    {
      "id": "VPm9vVEoERc6Wy6Jg7Jg",
      "start_date_unix": 1565833755,
      "next_renewal_date_unix": 1568512155,
      "product_sale": {
        "id": "Nk5vOzGAGRfrmg8LZXVM"
      },
      "product": {
        "id": "6r8O5MLbw2t6n4v1lGqK",
        "name": "AV 2017",
        "internal_id": "av_2017",
        "sku": "av_2017_sku"
      },
      "trial": null
    },
    {
      "id": "4r15qAlZlyUoMprMNVpE",
      "start_date_unix": 1565920155,
      "next_renewal_date_unix": null,
      "product_sale": {
        "id": "7rwyAzL5LXUa8QrGMoMR"
      },
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "name": "Robo Vac",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku"
      },
      "trial": {
        "id": "k6vn81lElqsvKEB4K2JA"
      }
    }
  ],
  "tax_created": [
    {
      "amount_original_total": 9.31,
      "amount_captured": 9.31,
      "amount_gross": 9.31,
      "amount_net": 9.06,
      "amount_fees": 0.25,
      "amount_remaining": 0,
      "amount_to_salvage": 0,
      "id": "2rdJNg4E4yUplpKWYnpo",
      "name": "User Provided Tax",
      "description": "Tax rate calculated using provided tax amount.",
      "rate": 0.08
    }
  ],
  "third_party_shop": null,
  "transaction_id": "vEwWZv5B5zIXM9bq1yQd",
  "trial_created": [
    {
      "id": "k6vn81lElqsvKEB4K2JA",
      "num_days": 1,
      "end_date_unix": 1565920155,
      "product_sale": {
        "id": "7rwyAzL5LXUa8QrGMoMR"
      },
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "name": "Robo Vac",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku"
      },
      "subscription": {
        "id": "4r15qAlZlyUoMprMNVpE"
      }
    }
  ],
  "usage_account_created": [
    {
      "id": "X8RqyywEwMU8XwLoK69A"
    }
  ],
  "usage_item_created": [
    {
      "id": "qZqRPPQowXfGbp8Xl0z9",
      "product_sale": {
        "id": "Nk5vOzGAGRfrmg8LZXVM"
      },
      "product": {
        "id": "6r8O5MLbw2t6n4v1lGqK",
        "name": "Usage Product 1",
        "internal_id": "usage_product_1",
        "sku": "usage_product_1"
      },
      "trial": null,
      "usage_account": {
        "id": "X8RqyywEwMU8XwLoK69A"
      }
    }
  ]
}</pre></div></div></div></section><section id="sale-create-credit-card" data-ordernum="98"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-create-credit-card"><h3>Sale Create Credit Card</h3><hr></hr><p>Example sale create object for credit card sales. Refer to the <a href="#sale-create">Sale Create</a> request section above for additional properties, including required properties.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object. In this example the payment type is credit card.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Value should be "credit_card".</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">credit_card<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by credit card.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">card_code<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card code as a string. Depending on the card type this can be different lengths.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_number<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card number. This value must be a valid credit card number as a string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_month<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month. Two digit integer, MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_year<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year. Two digit integer, YY.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">three_ds<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you are using 3DS2 you can send RevCent the 3DS2 response variables, which RevCent will pass to the gateway if 3DS2 is supported. <a href="https://kb.revcent.com/en/payments/credit-card/gateway#supported-gateways" target="_blank">View Supported Gateways <i class="small fa fa-fw fa-external-link"></i></a><br><br><strong class="text-danger">Important</strong>: You must set the "enabled" property to true in the "three_ds" object in order for RevCent to parse 3DS2 values.<br><br></p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If using 3DS2, this must be present and equal to true in order for RevCent to pass the additional variable to the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">version<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The 3DS2 version. Example: "2.1.0" or "2.2.0". On all successful authentications.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">eci<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The eCommerce indicator. Indicates the result of the attempt to authenticate the cardholder. On successful authentications.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cavv<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Cardholder Authentication Verification Value. On all successful authentications.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">xid<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction identifier from authentication processing. Occasionally provided for some card brands.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">directory_server_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A transaction identifier assigned by the directory server. On all successful authentications.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">authentication_response<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Describing if a customer was successfully verified or attempted. Example: "verified" or "attempted". On successful authentications.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">acs_transaction_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Access Control Server (ACS) transaction identifier.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">algorithm<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>3DS algorithm used.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">directory_response<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>3DS directory server response.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enrollment_response<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Verify enrollment response/status</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">three_ds_server_transaction_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>3DS server transaction id.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-create-credit-card-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "create",
    "payment": {
      "credit_card": {
        "card_number": "4242424242424242",
        "exp_month": 4,
        "exp_year": 22,
        "card_code": "000"
      },
      "payment_type": "credit_card"
    },
    "three_ds": {
      "enabled": true,
      "version": "2.2.0",
      "eci": "05",
      "cavv": "Y2FyZGluYWxjb21tZXJjZWF1dGg",
      "xid": "YXV0aCB0eG4gaWRzIGFyZSBmdW4=",
      "directory_server_id": "3f6fb1f8-f719-46c9-905b-bab446f4de30",
      "authentication_response": "attempted",
      "acs_transaction_id": "",
      "algorithm": "1",
      "directory_response": "Y",
      "enrollment_response": "Y",
      "three_ds_server_transaction_id": ""
    }
  }
}</pre><p class="col-code-p col-code-additional hidden ">Response JSON</p><pre id="sale-create-credit-card-response" class="highlight-code language-json hidden"></pre></div></div></div></section><section id="sale-create-paypal" data-ordernum="99"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-create-paypal"><h3>Sale Create PayPal</h3><hr></hr><p>Example sale create object for PayPal sales. Refer to the <a href="#sale-create">Sale Create</a> request section above for additional properties, including required properties.<br><br><strong class="text-danger">Important: </strong> The "is_pending" property should always be set to true when creating a PayPal sale via API.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_pending<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Value should always be set to true when creating a PayPal sale via API.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object. In this example the payment type is PayPal, therefore the paypal object is present and payment type is set to "paypal".</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Value should be "paypal" signifying that the payment is PayPal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The paypal object containing the PayPal transaction ID.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal transaction ID for the sale purchase.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-create-paypal-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "create",
    "is_pending": true,
    "payment": {
      "paypal": {
        "paypal_transaction_id": "01A23456B789101112"
      },
      "payment_type": "paypal"
    }
  }
}</pre><p class="col-code-p col-code-additional hidden ">Response JSON</p><pre id="sale-create-paypal-response" class="highlight-code language-json hidden"></pre></div></div></div></section><section id="sale-create-check-direct" data-ordernum="100"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-create-check-direct"><h3>Sale Create Check Direct</h3><hr></hr><p>Example sale create object for physical check sales. Refer to the <a href="#sale-create">Sale Create</a> request section above for additional properties, including required properties.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_pending<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Value should only be set to true if you are awaiting the check to arrive. Otherwise omit or set to false if already received physical check payment.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object. In this example the payment type is physical check, therefore the payment type is set to "check_direct".</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Value should be "check_direct" signifying that the payment is via physical check.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-create-check-direct-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "create",
    "payment": {
      "payment_type": "check_direct"
    }
  }
}</pre><p class="col-code-p col-code-additional hidden ">Response JSON</p><pre id="sale-create-check-direct-response" class="highlight-code language-json hidden"></pre></div></div></div></section><section id="sale-create-offline-payment" data-ordernum="101"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-create-offline-payment"><h3>Sale Create Offline Payment</h3><hr></hr><p>Example sale create object for offline payment sales. Refer to the <a href="#sale-create">Sale Create</a> request section above for additional properties, including required properties.<br><br>Note: You have the ability to create offline payment sales that come from specific third parties such as Sezzle and Afterpay, which integrate with RevCent. Please read more about <a href="https://kb.revcent.com/en/payments/offline#third-party-offline-payments" target="_blank">third party offline payments</a>, including the required metadata values in an <a href="https://kb.revcent.com/en/payments/offline#api" target="_blank">API request</a>.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object. In this example the payment type is offline payment, therefore the payment type is set to "offline_payment".</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Value should be "offline_payment" signifying that the payment is an offline payment, i.e. cash or other.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-create-offline-payment-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "create",
    "payment": {
      "payment_type": "offline_payment"
    }
  }
}</pre><p class="col-code-p col-code-additional hidden ">Response JSON</p><pre id="sale-create-offline-payment-response" class="highlight-code language-json hidden"></pre></div></div></div></section><section id="sale-pending" data-ordernum="102"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-pending"><h2>Pending Sale</h2><hr></hr><p>If you are utilizing upsells in your checkout process, the pending sale feature in RevCent can be extremely useful. A pending sale allows you to have RevCent store a sale, including any customer as well as payment information, without processing the payment. You can update the pending sale as many times as you wish and process the payment when ready using the saved payment information. You also have the ability to have RevCent automatically process an abandoned sale using a pending sale profile.<br><br>We <strong>highly recommend</strong> you read more about pending sales, including pending sale profiles, on our <a href="https://kb.revcent.com/revenue/sale/pending-sale" target="_blank">Knowledge Base  <i class="far fa-external-link-square-alt small"></i></a>.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="sale-pending-create" data-ordernum="103"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-pending-create"><h3>Pending Sale Create</h3><hr></hr><p>The request body is the same as a Sale Create call, except you include "is_pending: true" in the request. You can also omit properties normally required in a Sale Create call. You can add and/or update a pending sale before or when processing the final payment.<br><br><strong>Note:</strong> The example request JSON is a simplified example and does not include all properties available. Please refer to the <a href="#sale-create">Sale Create</a> section for full request JSON example and all properties that can be included in a pending sale create request, ignoring the returned properties as an pending sale create request returns a different response.<br><br><strong>Note:</strong> You can include the credit card information when first creating the pending sale. RevCent will save the credit card information and attach it to the pending sales' customer. When you are ready to process the pending sale you do not need to include the credit card information as it is has been saved and will be used for the payment.<br><br><strong>Note:</strong> You can include your own unique_request_id when creating a pending sale in order to reference the same pending sale in future updates or when processing the final payment. If you do not provide a unique_request_id in the create request, you can use the unique_request_id or RevCent sale_id in the pending sale create response for future updates or when processing the final payment.<br><br><strong class="text-danger">Required:</strong> You must include "is_pending: true" property in the request.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code. If not provided default is 'USD'.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_pending<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>You must include the is_pending property and set to true in order to create a pending sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to attach a unique ID to the pending sale so you can reference the pending sale in future updates or when processing the final payment. Once a sale has been created with a unique request ID you cannot use the same ID to create another separate sale.<br><br> An example unique_request_id would be a specific order ID in your shopping cart, that you will want to use in order to update or complete payment in the future.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object is not required when creating a pending sale. However, if you do include the payment object, the payment information will be saved and attached to the pending sales' customer for future payment.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">credit_card<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by credit card.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">card_code<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card code as a string. Depending on the card type this can be different lengths.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_number<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card number. This value must be a valid credit card number as a string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_month<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month. Two digit integer, MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_year<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year. Two digit integer, YY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">set_as_default<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by PayPal, and already processed by PayPal with a return transaction ID.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal transaction ID, provided by PayPal for the corresponding transaction.<br><br>PayPal payments are processed by PayPal and not RevCent, therefore RevCent needs the transaction ID to create a PayPal sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_account_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">force_transaction<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Default: false. RevCent verifies all PayPal transactions using the PayPal API before officially confirming the sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_direct<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is a physical check, not ACH or electronic.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">check_number<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">mail_to_address<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify the mailing address for a customer to mail the physical check to. Useful when utilizing SMTP messages containing customer instructions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pay_to_address<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify the pay to address for a customer to make the check out to. Useful when utilizing SMTP messages containing customer instructions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is in cash, etc., or it is necessary to create a sale without an actual payment type.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details later.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you are creating a pending sale for an existing customer. This value can be the RevCent customer ID or your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bill_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The bill_to object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details when processing a payment.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to associate the sale with a third party shop provide the RevCent ID for the third party shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a payment profile for processing the item payment. This value can either be the RevCent payment profile ID or the custom payment profile name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_sale_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal sale ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product array contains individual product objects.<br><br>Pricing is automatically calculated based upon the quantity, price or both if present.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price, if different from the product default price, you wish to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity. Default is 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_end_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_days<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending after the number of days provided.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the shipping information. Any shipping entries created will use the ship_to object field.<br><br>If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping array. Can contain multiple shipping objects.<br><br><strong>Note:</strong> View our <a href="https://kb.revcent.com/en/revenue/shipping#provider-method-table" target="_blank">Provider Method Table <i class="small fa fa-fw fa-external-link"></i></a> for mapping provider and provider_method values for shipping object entries.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your shipping cost. This is for your internal purposes.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">free_shipping<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether you wish to internally identify this as a free shipping item. This value will NOT be used to calculate any amounts. This if for your internal purposes. Default: false</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tax array. Can contain multiple tax objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon array. Can contain multiple coupon objects, each containing a coupon code.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount array. Can contain multiple discount objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_value<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The actual discount value according to the discount type. Currently the discount value is a fixed amount, i.e. 5 will deduct the sale price by 5.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type. Default: amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount description.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the pending sale. You can use this to reference the pending sale in future updates or to process the final payment.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unique request ID for the pending sale, either created by RevCent or supplied by you in the request. You can use this to reference the pending sale in future updates or to process the final payment.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-pending-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "create",
    "campaign": "Adwords Campaign",
    "iso_currency": "USD",
    "is_pending": true,
    "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5",
    "customer": {
      "first_name": "George",
      "last_name": "Washington",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "george@whitehouse.gov",
      "phone": "1234567890"
    },
    "payment": {
      "credit_card": {
        "card_number": "4242424242424242",
        "exp_month": 4,
        "exp_year": 22,
        "card_code": "000"
      },
      "payment_type": "credit_card"
    },
    "product": [
      {
        "id": "robo_vac",
        "quantity": 1
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-pending-create-response" class="highlight-code language-json ">{
  "amount": 34.99,
  "api_call_id": "k6aGmwLkABi0822wnp67",
  "api_call_processed": true,
  "api_call_unix": 1613326956,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "6rKPj6nlXACJRKKd5nXa",
  "payment_type": "Credit Card",
  "request_method": "create",
  "request_type": "sale",
  "result": "Pending sale created.",
  "sale_id": "0pKnzNPq54U2yvvzJwVY",
  "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
}</pre></div></div></div></section><section id="sale-pending-update" data-ordernum="104"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-pending-update"><h3>Pending Sale Update</h3><hr></hr><p>The request body will always be the same as a pending sale create call, except you include the unique_request_id, as well as "is_pending: true", to signify you are updating a previously created pending sale.<br><br><strong>Note:</strong> The example request JSON is a simplified example and does not include all properties available. Please refer to the <a href="#sale-create">Sale Create</a> section for full request JSON example and all properties that can be included in a pending sale update request, ignoring returned properties as an pending sale update request returns a different response.<br><br><strong class="text-danger">Required:</strong> You must include "is_pending: true" property in the request.<br><br><strong class="text-danger">Required:</strong> You must include the unique_request_id of the pending sales' initial response. If you omit the unique_request_id field, then RevCent will create a new pending sale, as there is no way to know which sale you are updating.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code. If not provided default is 'USD'.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_pending<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>You must include the is_pending property and set to true in order to update a pending sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>You must include the unique_request_id, or the RevCent sale_id, of the existing pending sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product array contains individual product objects.<br><br>Pricing is automatically calculated based upon the quantity, price or both if present.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price, if different from the product default price, you wish to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity. Default is 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_end_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_days<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending after the number of days provided.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_options<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>When updating a pending sale you have options available that allow you to specify what actions occur given specific conditions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">exists_options<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The options for each request entity, in which to update the pending sale for existing entities.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>What to do with product(s) submitted in the update in regards to product(s) already existing in the pending sale. I.e. Replace, skip, or merge line items already in a pending sale with line items submitted. Note: RevCent matches each product based on the "id" value submitted in the original request and update request.<br>Accepted values:<br><dl class="dl-horizontal"><dt>replace</dt><dd>Will remove all existing product(s) in the pending sale and replace with product(s) submitted in the request. I.e. Only product(s) submitted will be in the sale after update. <strong>Default</strong></dd><br><dt>skip</dt><dd>Will leave existing product(s) in the sale and not add any new product(s) submitted. I.e. ignoring product(s) submitted. Useful when updating other parts of a pending sale such as payment information, discounts, etc.</dd><br><dt>merge_replace</dt><dd>Will add any new product(s) to the pending sale, keep existing product(s) in the sale and replace existing same ID product(s) with product(s) submitted. I.e. When you want to update a pending sale with new product(s) not already in the sale, keep all existing product(s) but replace same ID existing product(s) with submitted product(s).</dd><br><dt>merge_skip</dt><dd>Will add any new product(s) to the pending sale, and not remove or modify any product(s) which already exist in the sale. I.e. Add new product(s) to an existing sale without touching existing product(s).</dd><br><dt>merge_combine</dt><dd>Will add any new product(s) to the pending sale, keep existing product(s) in the sale, and combine the quantities of existing product(s) with submitted same ID product(s). I.e. Add any new product(s) to the pending sale, keep existing product(s) in the sale and incrementing submitted quantity with same ID existing product(s) quantity.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>What to do if discounts already exists in the pending sale.<br>Accepted values:<br><dl class="dl-horizontal"><dt>replace</dt><dd>Will replace existing discounts with new discounts. <strong>Default</strong></dd><br><dt>skip</dt><dd>Will skip if discounts exist.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>What to do if shipping already exists in the pending sale.<br>Accepted values:<br><dl class="dl-horizontal"><dt>replace</dt><dd>Will replace existing shipping with new shipping. <strong>Default</strong></dd><br><dt>skip</dt><dd>Will skip if shipping exists.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>What to do if tax already exists in the pending sale.<br>Accepted values:<br><dl class="dl-horizontal"><dt>replace</dt><dd>Will replace existing tax with new tax. <strong>Default</strong></dd><br><dt>skip</dt><dd>Will skip if tax exists.</dd></dl></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object is not required when creating a pending sale. However, if you do include the payment object, the payment information will be saved and attached to the pending sales' customer for future payment.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">credit_card<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by credit card.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">card_code<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card code as a string. Depending on the card type this can be different lengths.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_number<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card number. This value must be a valid credit card number as a string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_month<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month. Two digit integer, MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_year<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year. Two digit integer, YY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">set_as_default<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by PayPal, and already processed by PayPal with a return transaction ID.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal transaction ID, provided by PayPal for the corresponding transaction.<br><br>PayPal payments are processed by PayPal and not RevCent, therefore RevCent needs the transaction ID to create a PayPal sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_account_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">force_transaction<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Default: false. RevCent verifies all PayPal transactions using the PayPal API before officially confirming the sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_direct<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is a physical check, not ACH or electronic.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">check_number<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">mail_to_address<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify the mailing address for a customer to mail the physical check to. Useful when utilizing SMTP messages containing customer instructions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pay_to_address<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify the pay to address for a customer to make the check out to. Useful when utilizing SMTP messages containing customer instructions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is in cash, etc., or it is necessary to create a sale without an actual payment type.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details later.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you are creating a pending sale for an existing customer. This value can be the RevCent customer ID or your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bill_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The bill_to object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details when processing a payment.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to associate the sale with a third party shop provide the RevCent ID for the third party shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a payment profile for processing the item payment. This value can either be the RevCent payment profile ID or the custom payment profile name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_sale_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal sale ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the shipping information. Any shipping entries created will use the ship_to object field.<br><br>If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping array. Can contain multiple shipping objects.<br><br><strong>Note:</strong> View our <a href="https://kb.revcent.com/en/revenue/shipping#provider-method-table" target="_blank">Provider Method Table <i class="small fa fa-fw fa-external-link"></i></a> for mapping provider and provider_method values for shipping object entries.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your shipping cost. This is for your internal purposes.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">free_shipping<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether you wish to internally identify this as a free shipping item. This value will NOT be used to calculate any amounts. This if for your internal purposes. Default: false</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tax array. Can contain multiple tax objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon array. Can contain multiple coupon objects, each containing a coupon code.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount array. Can contain multiple discount objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_value<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The actual discount value according to the discount type. Currently the discount value is a fixed amount, i.e. 5 will deduct the sale price by 5.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type. Default: amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount description.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the pending sale. You can use this to reference the pending sale in future updates or to process the final payment.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unique request ID for the pending sale, either created by RevCent or supplied by you in the request. You can use this to reference the pending sale in future updates or to process the final payment.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-pending-update-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "create",
    "campaign": "Adwords Campaign",
    "is_pending": true,
    "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5",
    "product": [
      {
        "id": "robo_vac",
        "quantity": 2
      },
      {
        "id": "av_2017",
        "quantity": 1
      }
    ],
    "pending_options": {
      "exists_options": {
        "product": "merge_combine",
        "discount": "replace",
        "shipping": "skip",
        "tax": "replace"
      }
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-pending-update-response" class="highlight-code language-json ">{
  "amount": 75.7,
  "api_call_id": "X82JQZYRyqUqajGypN9l",
  "api_call_processed": true,
  "api_call_unix": 1613349181,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "6rKPj6nlXACJRKKd5nXa",
  "payment_type": "Credit Card",
  "request_method": "create",
  "request_type": "sale",
  "result": "Pending sale updated.",
  "sale_id": "0pKnzNPq54U2yvvzJwVY",
  "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
}</pre></div></div></div></section><section id="sale-pending-process" data-ordernum="105"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-pending-process"><h3>Pending Sale Process</h3><hr></hr><p>Process a pending sale, i.e. charge credit card, using the sale create API call <strong>without</strong> including the "is_pending" property in the request. By not including the "is_pending" property, RevCent assumes that the sale is to be processed. Any payment methods submitted in the process request, or submitted previously while the sale is pending, will be used to process the payment of the pending sale.<br><br><strong>Note:</strong> The example request JSON is a simplified example and does not include all properties available. Please refer to the <a href="#sale-create">Sale Create</a> section for full request JSON example and all properties that can be included in a pending sale process request. The response JSON for pending sale process is omitted as it is the same that will be returned in the sale create response.<br><br><strong>Note:</strong> If using a credit card payment type, you must include either the payment_profile or gateway property.<br><br><strong class="text-danger">Required:</strong> Do not include "is_pending", or set "is_pending: false", in the pending sale process request to ensure that RevCent processes the payment and does not simply update the pending sale.<br><br><strong class="text-danger">Required:</strong> You must include the unique_request_id of the pending sales' initial response. If you omit the unique_request_id field, then RevCent will create a new sale, as there is no way to know which pending sale you are processing.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code. If not provided default is 'USD'.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a specific gateway for processing the pending sale. This value can either be the RevCent gateway ID or the custom gateway name you created. You can also use a payment profile instead of a gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a payment profile for processing the pending sale. This value can either be the RevCent payment profile ID or the custom payment profile name you created. You can also use a gateway instead of a payment profile.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_pending<div class="boolean-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>You must include the is_pending property and set to false in order to process a pending sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>You must include the unique_request_id, or the RevCent sale_id, of the existing pending sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product array contains individual product objects.<br><br>Pricing is automatically calculated based upon the quantity, price or both if present.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price, if different from the product default price, you wish to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity. Default is 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_end_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_days<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending after the number of days provided.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_options<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>When updating a pending sale you have options available that allow you to specify what actions occur given specific conditions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">exists_options<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The options for each request entity, in which to update the pending sale for existing entities.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>What to do for each individual product submitted, if the product already exists in the pending sale. RevCent matches each product based on the id value submitted in the original request and update request.<br>Accepted values:<br><dl class="dl-horizontal"><dt>replace</dt><dd>Will replace an existing product with the new product. <strong>Default</strong></dd><br><dt>skip</dt><dd>Will skip if product exists.</dd><br><dt>merge_replace</dt><dd>Will add any new products to the pending sale, and replace any products which already exist.</dd><br><dt>merge_skip</dt><dd>Will add any new products to the pending sale, and skip any products which already exist.</dd><br><dt>merge_combine</dt><dd>Will add any new products to the pending sale, and combine the quantities of both existing and new products which already exist.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>What to do if discounts already exists in the pending sale.<br>Accepted values:<br><dl class="dl-horizontal"><dt>replace</dt><dd>Will replace existing discounts with new discounts. <strong>Default</strong></dd><br><dt>skip</dt><dd>Will skip if discounts exist.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>What to do if shipping already exists in the pending sale.<br>Accepted values:<br><dl class="dl-horizontal"><dt>replace</dt><dd>Will replace existing shipping with new shipping. <strong>Default</strong></dd><br><dt>skip</dt><dd>Will skip if shipping exists.</dd></dl></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>What to do if tax already exists in the pending sale.<br>Accepted values:<br><dl class="dl-horizontal"><dt>replace</dt><dd>Will replace existing tax with new tax. <strong>Default</strong></dd><br><dt>skip</dt><dd>Will skip if tax exists.</dd></dl></p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object is not required when creating a pending sale. However, if you do include the payment object, the payment information will be saved and attached to the pending sales' customer for future payment.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">credit_card<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by credit card.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">card_code<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card code as a string. Depending on the card type this can be different lengths.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_number<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card number. This value must be a valid credit card number as a string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_month<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month. Two digit integer, MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_year<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year. Two digit integer, YY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">set_as_default<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is by PayPal, and already processed by PayPal with a return transaction ID.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transaction_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The PayPal transaction ID, provided by PayPal for the corresponding transaction.<br><br>PayPal payments are processed by PayPal and not RevCent, therefore RevCent needs the transaction ID to create a PayPal sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_account_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">force_transaction<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Default: false. RevCent verifies all PayPal transactions using the PayPal API before officially confirming the sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_direct<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is a physical check, not ACH or electronic.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">check_number<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">mail_to_address<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify the mailing address for a customer to mail the physical check to. Useful when utilizing SMTP messages containing customer instructions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pay_to_address<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify the pay to address for a customer to make the check out to. Useful when utilizing SMTP messages containing customer instructions.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If payment is in cash, etc., or it is necessary to create a sale without an actual payment type.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details later.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you are creating a pending sale for an existing customer. This value can be the RevCent customer ID or your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bill_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The bill_to object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details when processing a payment.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to associate the sale with a third party shop provide the RevCent ID for the third party shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal customer ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_sale_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal sale ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the shipping information. Any shipping entries created will use the ship_to object field.<br><br>If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping array. Can contain multiple shipping objects.<br><br><strong>Note:</strong> View our <a href="https://kb.revcent.com/en/revenue/shipping#provider-method-table" target="_blank">Provider Method Table <i class="small fa fa-fw fa-external-link"></i></a> for mapping provider and provider_method values for shipping object entries.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your shipping cost. This is for your internal purposes.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">free_shipping<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether you wish to internally identify this as a free shipping item. This value will NOT be used to calculate any amounts. This if for your internal purposes. Default: false</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tax array. Can contain multiple tax objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon array. Can contain multiple coupon objects, each containing a coupon code.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount array. Can contain multiple discount objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_value<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The actual discount value according to the discount type. Currently the discount value is a fixed amount, i.e. 5 will deduct the sale price by 5.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type. Default: amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount description.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-pending-process-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "create",
    "campaign": "Adwords Campaign",
    "payment_profile": "MyPaymentProfile",
    "is_pending": false,
    "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
  }
}</pre><p class="col-code-p col-code-additional hidden ">Response JSON</p><pre id="sale-pending-process-response" class="highlight-code language-json hidden"></pre></div></div></div></section><section id="sale-pending-cancel" data-ordernum="106"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-pending-cancel"><h3>Pending Sale Cancel</h3><hr></hr><p>Cancel a pending sale by using the sale void API call. This will cancel the pending sale, and if you already processed the sale it will refund any payments.<br><br><strong class="text-danger">Required:</strong> You must include the unique_request_id of the pending sale.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>You must include the unique_request_id, or the RevCent sale_id, of the existing pending sale.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each pending refund created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each product sale refunded as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each shipping refunded as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_cancelled<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each subscription cancelled as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each tax refunded as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_cancelled<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each trial cancelled as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unique request ID for the pending sale.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-pending-cancel-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "void",
    "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-pending-cancel-response" class="highlight-code language-json ">{
  "amount": 0,
  "api_call_id": "ajYwEoMdL2i7g8VrZQNd",
  "api_call_processed": true,
  "api_call_unix": 1613398750,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "6rKPj6nlXACJRKKd5nXa",
  "pending_refund": [],
  "product_sale_refunded": [],
  "request_method": "void",
  "request_type": "sale",
  "result": "Sale successfully void.",
  "sale_id": "0pKnzNPq54U2yvvzJwVY",
  "subscription_cancelled": [],
  "trial_cancelled": [],
  "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
}</pre></div></div></div></section><section id="sale-upsell" data-ordernum="107"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-upsell"><h2>Upsell Profile</h2><hr></hr><p>An Upsell Profile is a feature within RevCent allowing the return of recommended products within an API response. The upsell object provided in the API response is meant to be used when creating or updating a pending sale.<br><br>If you have created an Upsell Profile and a matching upsell is found, RevCent will return an upsell object in a sale request response. The upsell object contains a recommended product, as well as additional products. The upsell object can be returned when processing payment on a sale, creating a pending sale or estimating a sale.<br><br>Read more about upsells and upsell profiles on our <a href="https://kb.revcent.com/en/revenue/sale/upsell-profile" target="_blank">Knowledge Base  <i class="far fa-external-link-square-alt small"></i></a>.</p><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">upsell<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsell object provided in a sale response, if an upsell is found.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">product_recommended<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The final recommended product based upon the upsell profiles' product order setting.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent product ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description_html<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The HTML description of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">images<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of images for the product, if uploaded within the web app.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>RevCent image ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">featured<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether you set the image as featured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">file_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Image file name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">file_ext<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Image file extension.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">image_width<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>Image width.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">image_height<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>Image height.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">mimetype<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Image mimetype.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">base_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Base URL for the product image.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Full URL for the product image.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">compressed_extensions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Various compressed images indicated by width.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">source_upsell<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The source upsell for the recommended product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsell ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsell name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsell description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">match_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of matches within the upsells' interested list.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">match_percent<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsells' match percentage as an integer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">match_score<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsells' match score.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">upsell_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsell profile the upsell was contained in.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsell profile ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsell profile name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The upsell profile description.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">all_products<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>All products, ordered, contained in the upsells' recommended list, up to a maximum of 5. Each product is an object in the same format and schema as the recommended_product object above.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first hidden">Request JSON</p><pre id="sale-upsell-request" class="highlight-code language-json hidden"></pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-upsell-response" class="highlight-code language-json ">{
  "upsell": {
    "product_recommended": {
      "id": "GOKzajKyuA7bVEREGydz",
      "sku": "robo_vac",
      "name": "Robo Vac",
      "price": 12,
      "description": "",
      "description_html": "",
      "images": [
        {
          "id": "vEYOMCBMrNM9mqMBlwQ2",
          "featured": false,
          "file_name": "vEYOMCBMrNM9mqMBlwQ2",
          "file_ext": "png",
          "image_width": 797,
          "image_height": 142,
          "mimetype": "image/png",
          "base_url": "https://productimg.revcent.com",
          "full_url": "https://productimg.revcent.com/vEYOMCBMrNM9mqMBlwQ2.png",
          "compressed_extensions": [
            "_resize_300",
            "_resize_150",
            "_resize_600"
          ]
        }
      ]
    },
    "source_upsell": {
      "id": "685fc32f",
      "name": "More",
      "description": "",
      "match_count": 2,
      "match_percent": 50,
      "match_score": 125,
      "upsell_profile": {
        "id": "l4Vol84qpBUZ4Ba7My9y",
        "name": "My Upsell Profile",
        "description": ""
      },
      "all_products": []
    }
  }
}</pre></div></div></div></section><section id="sale-void" data-ordernum="108"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-void"><h3>Sale Void</h3><hr></hr><p>Voiding a sale will void all product sales, tax and shipping associated with the sale. Any subscriptions or trials created will be cancelled. The actual transactions associated with the sale will be refunded. Transactions that have yet to settle will be in a pending refund phase until it has settled. It is important to note that voiding a sale is irreversible.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sale ID</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each pending refund created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each product sale refunded as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each shipping refunded as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_cancelled<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each subscription cancelled as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_refunded<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each tax refunded as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_cancelled<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each trial cancelled as a result of the request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-void-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "void",
    "sale_id": "rm9EG1BjrXcqm64KKq6z"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-void-response" class="highlight-code language-json ">{
  "amount": 261.85,
  "api_call_id": "8rwvAzV97NU6aN4djRQo",
  "api_call_processed": true,
  "api_call_unix": 1565833758,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "ajOAl24bBXc5nXwagAOg",
  "pending_refund": [
    "EMwJaz1m76TElBwVOQl4",
    "0pwoAb5L1vfXyJ5dgQod",
    "LY5yMzq27wIJO5BJmPa5",
    "k6vn81AXpOfv8JlB8Xkn"
  ],
  "product_sale_refunded": [
    "8rwvAzd6dQU6kXkB2VQq",
    "Nk5vOzGAGRfrmg8LZXVM",
    "7rwyAzL5LXUa8QrGMoMR"
  ],
  "request_method": "void",
  "request_type": "sale",
  "result": "Sale successfully void.",
  "sale_id": "rm9EG1BjrXcqm64KKq6z",
  "shipping_refunded": [
    "Q45o8zGpGRu098B88npR"
  ],
  "subscription_cancelled": [
    "VPm9vVEoERc6Wy6Jg7Jg",
    "4r15qAlZlyUoMprMNVpE"
  ],
  "tax_refunded": [
    "2rdJNg4E4yUplpKWYnpo"
  ],
  "trial_cancelled": [
    "k6vn81lElqsvKEB4K2JA"
  ]
}</pre></div></div></div></section><section id="sale-estimate" data-ordernum="109"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-estimate"><h3>Sale Estimate</h3><hr></hr><p>Estimate the total cost with itemized results including products, shipping, tax, coupons and discounts.<br><br>The request object is the same as the the <a href="#sale-create">sale create</a> request object, except the request method is "estimate" and not "create".<br><br>The response object contains detailed information that can be useful for displaying information to a customer during checkout, including how much the customer will save due to discounts.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bill_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the billing information. If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object receives first priority as details if creating a new customer.<br><br>If the customer object is not present the bill_to and ship_to objects will be used in the respective order.<br><br>If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.<br><br>This does not apply if using a customer_id field in the request where applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a payment profile for processing the item payment. This value can either be the RevCent payment profile ID or the custom payment profile name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product array contains individual product objects.<br><br>Pricing is automatically calculated based upon the quantity, price or both if present.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price, if different from the product default price, you wish to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity. Default is 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_end_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">custom_trial_days<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Create a trial for the specific product being sold ending after the number of days provided.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the shipping information. Any shipping entries created will use the ship_to object field.<br><br>If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping array. Can contain multiple shipping objects.<br><br><strong>Note:</strong> View our <a href="https://kb.revcent.com/en/revenue/shipping#provider-method-table" target="_blank">Provider Method Table <i class="small fa fa-fw fa-external-link"></i></a> for mapping provider and provider_method values for shipping object entries.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your shipping cost. This is for your internal purposes.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">free_shipping<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether you wish to internally identify this as a free shipping item. This value will NOT be used to calculate any amounts. This if for your internal purposes. Default: false</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shipping name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tax array. Can contain multiple tax objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax amount to charge.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon array. Can contain multiple coupon objects, each containing a coupon code.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount array. Can contain multiple discount objects.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_value<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The actual discount value according to the discount type. Currently the discount value is a fixed amount, i.e. 5 will deduct the sale price by 5.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type. Default: amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount description.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupons<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>A breakdown of both valid and invalid coupons if one or more coupon codes are submitted in the request.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">valid<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of valid coupons if one or more coupon codes are submitted in the request.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code submitted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the coupon you created in RevCent.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the related coupon profile you created in RevCent.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_percent<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount percentage (discount_multiplier * 100) rounded to max two decimal places.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_multiplier<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount multiplier, i.e. the mathematical number to apply to the total amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount value relative to the discount type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type relative to the discount value.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">invalid<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of invalid coupons if one or more coupon codes are submitted in the request.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code submitted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">errors<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of error messages as to why the coupon code is invalid.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">potential<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will list available coupons not submitted that can apply to the submitted estimate. Not yet implemented but coming in a future API update.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual discount items, which will be created if the sale is successfully processed.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_percent<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount percentage (discount_multiplier * 100) rounded to max two decimal places.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_multiplier<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount multiplier, i.e. the mathematical number to apply to the total amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount value relative to the discount type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type relative to the discount value.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_coupon<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the discount is a result of a coupon code or a static discount submitted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_id<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the discount is the result of a coupon, the coupon ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_uuid<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unique ID of the coupon in the coupons array.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of product entries that the discount is being applied to if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_percent<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount percentage (discount_multiplier * 100) rounded to max two decimal places.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_multiplier<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount multiplier, i.e. the mathematical number to apply to the total amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount_with_discount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount the customer will pay for the specific product after the discount has been applied.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of shipping entries that the discount is being applied to if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_percent<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount percentage (discount_multiplier * 100) rounded to max two decimal places.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_multiplier<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount multiplier, i.e. the mathematical number to apply to the total amount.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual product items, which will be created if the sale is successfully processed.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount before any applicable discounts are applied.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_trial<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the product will created a trial.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_trial_ship_now<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the product is a trial product, whether the product will ship immediately upon sale completion.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_free_product<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the product is a free product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_uuid<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of unique discount IDs that apply to the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_percent<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount percentage (discount_multiplier * 100) rounded to max two decimal places.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_multiplier<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount multiplier, i.e. the mathematical number to apply to the total amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount_with_discount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total product amount after discounts are applied.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">max_quantity_allowed<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The maximum quantity of the product the customer is able to purchase based on product settings.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual shipping items, which will be created if the sale is successfully processed.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The individual shipping amount</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of products which will be associated with the specific shipping item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">uuid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount_with_discount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total shipping amount after any discounts are applied.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of individual tax items, which will be created if the sale is successfully processed.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calculated tax rate.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total tax amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">totals<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The totals object, containing the sum of all related products, shipping, discounts and tax. Ultimate amounts are based on any delayed trial amounts, which the customer will not pay immediately.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount the customer will ultimately pay for all items including any discounts applied.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_bill_now<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount the customer will immediately pay upon initial sale purchase.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The breakdown of ultimate and immediate amounts for all products the customer will pay.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ultimate amount the customer will pay for products.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_bill_now<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The immediate amount the customer will pay for products before any applicable discounts are applied.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_bill_now_with_discount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The immediate amount the customer will pay for products after any applicable discounts are applied.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The breakdown of ultimate and immediate amounts for all shipping the customer will pay.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ultimate amount the customer will pay for shipping.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_bill_now<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The immediate amount the customer will pay for shipping before any applicable discounts are applied.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_bill_now_with_discount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The immediate amount the customer will pay for shipping after any applicable discounts are applied.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The breakdown of the total discount amount.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The immediate discount amount being applied to purchase.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The breakdown of ultimate and immediate amounts for all tax the customer will pay.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ultimate amount the customer will pay for tax.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_bill_now<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The immediate amount the customer will pay for tax.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-estimate-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "estimate",
    "campaign": "Facebook Campaign",
    "coupon": [
      {
        "coupon_code": "10percent"
      },
      {
        "coupon_code": "invalidCode"
      }
    ],
    "discount": [
      {
        "discount_value": 5,
        "discount_type": "amount",
        "name": "$5 Off Coupon",
        "description": "$5 Off Coupon from facebook link."
      }
    ],
    "customer": {
      "first_name": "ffms",
      "last_name": "qtfgzzql",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "qqcg@gmail.com",
      "phone": "1234567890"
    },
    "bill_to": {
      "first_name": "ffms",
      "last_name": "qtfgzzql",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "qqcg@gmail.com",
      "phone": "1234567890"
    },
    "ship_to": {
      "first_name": "ffms",
      "last_name": "qtfgzzql",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "qqcg@gmail.com",
      "phone": "1234567890"
    },
    "product": [
      {
        "id": "usb_hdd",
        "quantity": 2
      }
    ],
    "shipping": [
      {
        "amount": 45.64,
        "name": "FedEx",
        "description": "",
        "provider": "ups",
        "provider_method": "ups ground"
      }
    ],
    "tax": [
      {
        "amount": 10.71,
        "rate": 7.3,
        "name": "State Sales",
        "description": "seven percent"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-estimate-response" class="highlight-code language-json ">{
  "api_call_id": "O05VMKEmqZIRq77gP49O",
  "api_call_processed": true,
  "api_call_unix": 1570463562,
  "code": 1,
  "coupons": {
    "valid": [
      {
        "uuid": "133e489d-09fc-455b-ba7c-2d3e6f4d0372",
        "coupon_code": "10percent",
        "coupon_id": "VPmmrpbVl7cQ9JaXEanl",
        "coupon_profile_id": "k6vvXQwwNycvJM7yMwzL",
        "discount": {
          "uuid": "e5429d8a-588e-4ec2-ad09-f7ad36894ead",
          "discount_amount": 22.06,
          "discount_percent": 10,
          "discount_multiplier": 0.1,
          "discount_value": 10,
          "discount_type": "percent"
        }
      }
    ],
    "invalid": [
      {
        "uuid": "f3070b93-8042-43d6-a52b-4850e23ed5d4",
        "coupon_code": "invalidCode",
        "errors": [
          "Coupon code invalid."
        ]
      }
    ],
    "potential": []
  },
  "discounts": [
    {
      "uuid": "aeafd3b2-f724-45c9-83e3-f4e0f286fc45",
      "discount_amount": 5,
      "discount_percent": 2.22,
      "discount_multiplier": 0.022161155925893093,
      "discount_type": "amount",
      "discount_value": 5,
      "is_coupon": false,
      "coupon_id": null,
      "coupon_uuid": null,
      "products": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "uuid": "fef9b23e-2cc7-4e9d-90af-98d7117115e1",
          "discount_amount": 3.99,
          "discount_multiplier": 0.022169129903322593,
          "discount_percent": 2.22,
          "total_amount_with_discount": 175.99
        }
      ],
      "shipping": [
        {
          "uuid": "d57ed1cc-7914-4e3c-8954-d311e5194b84",
          "discount_amount": 0,
          "discount_multiplier": 0,
          "discount_percent": 0
        }
      ]
    },
    {
      "uuid": "e5429d8a-588e-4ec2-ad09-f7ad36894ead",
      "discount_amount": 22.06,
      "discount_percent": 10,
      "discount_multiplier": 0.1,
      "discount_type": "percent",
      "discount_value": 10,
      "is_coupon": true,
      "coupon_id": "VPmmrpbVl7cQ9JaXEanl",
      "coupon_uuid": "133e489d-09fc-455b-ba7c-2d3e6f4d0372",
      "products": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "uuid": "fef9b23e-2cc7-4e9d-90af-98d7117115e1",
          "discount_amount": 21.59,
          "discount_multiplier": 0.11995777308589843,
          "discount_percent": 12,
          "total_amount_with_discount": 158.39
        }
      ],
      "shipping": [
        {
          "uuid": "d57ed1cc-7914-4e3c-8954-d311e5194b84",
          "discount_amount": 1.01,
          "discount_multiplier": 0.02212971078001753,
          "discount_percent": 2.21,
          "total_amount_with_discount": 44.63
        }
      ]
    }
  ],
  "products": [
    {
      "uuid": "fef9b23e-2cc7-4e9d-90af-98d7117115e1",
      "id": "k6EXjKzd7PHOpgvdYjXG",
      "name": "USB HDD",
      "description": "",
      "quantity": 2,
      "price": 89.99,
      "total_amount": 179.98,
      "is_trial": false,
      "is_trial_ship_now": false,
      "is_free_product": false,
      "discount_uuid": [
        "aeafd3b2-f724-45c9-83e3-f4e0f286fc45",
        "e5429d8a-588e-4ec2-ad09-f7ad36894ead"
      ],
      "discount_amount": 21.59,
      "discount_multiplier": 0.11995777308589843,
      "discount_percent": 12,
      "total_amount_with_discount": 158.39,
      "max_quantity_allowed": 0
    }
  ],
  "request_method": "estimate",
  "request_type": "sale",
  "shipping": [
    {
      "uuid": "d57ed1cc-7914-4e3c-8954-d311e5194b84",
      "amount": 45.64,
      "products": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "uuid": "fef9b23e-2cc7-4e9d-90af-98d7117115e1",
          "quantity": 2
        }
      ],
      "provider": "ups",
      "provider_method": "ups_other",
      "total_amount_with_discount": 40.17
    }
  ],
  "tax": [
    {
      "rate": 0.05,
      "amount": 10.71
    }
  ],
  "totals": {
    "amount_total": 236.33,
    "amount_bill_now": 209.27,
    "products": {
      "amount_total": 158.39,
      "amount_bill_now_with_discount": 158.39,
      "amount_bill_now": 179.98
    },
    "shipping": {
      "amount_total": 40.17,
      "amount_bill_now_with_discount": 40.17,
      "amount_bill_now": 45.64
    },
    "discount": {
      "amount_total": 27.06
    },
    "tax": {
      "amount_total": 10.71,
      "amount_bill_now": 10.71
    }
  }
}</pre></div></div></div></section><section id="sale-retrieve" data-ordernum="110"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-retrieve"><h3>Sale Retrieve</h3><hr></hr><p>Retrieve current information on a single sale or multiple sales.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount discounted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any refunds.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_settled<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount settled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_void<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any items that have been voided.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_calls<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing api call IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cancelled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the sale was pending payment and ultimately cancelled without processing payment.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount type, either percent or amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_amount<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount amount after all calculations.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discount_percent<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The discount percent of the overall amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The coupon code.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_endpoint<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted endpoint related to the sale, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted endpoint ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted endpoint name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">path<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted endpoint path.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page related to the sale, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">path<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page path.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page_template<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted page template related to the sale, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted page template ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted page template name.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page_visit<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted page visit related to the sale, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The hosted page visit ID.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_check_direct<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the item was created using a check_direct payment method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_check_direct_pending<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the sale is currently pending payment with a payment type of check_direct. I.e. waiting for check receipt before processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_offline_payment<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the item was created using an offline payment method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Payment profile related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_transaction_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">final_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_declined_transactions<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">original_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">step_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_cascade_result<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled_gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_transaction<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_payment<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the sale is currently pending payment.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products_detailed<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Products detailed is an array of individual product objects, indicating the products which are related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the product</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of the product. I.e. Price * Quantity</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product internal ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product SKU.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">images<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product images if uploaded to RevCent.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ship to object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of shipping for the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of tax for the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tracking_visitor<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent tracking visitor related to the item, if TrackJS was initialized.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking visitor ID.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unique_request_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unique_request_id provided, or system generated, during the initial request creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "retrieve",
    "id": "k6vnbJom00Ug89mpRj78"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "0pwokmw491i00V4Zl8qb",
  "api_call_processed": true,
  "api_call_unix": 1565814902,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "sale",
  "results": [
    {
      "amount_captured": 111.86,
      "amount_discounted": 0,
      "amount_fees": 3.02,
      "amount_gross": 111.86,
      "amount_net": 108.84,
      "amount_original_total": 274.28,
      "amount_refunded": 0,
      "amount_remaining": 162.42,
      "amount_settled": 0,
      "amount_to_salvage": 12.43,
      "amount_total": 274.28,
      "amount_void": 0,
      "api_calls": [
        "O051o2XaAAUXnXwwr4O9"
      ],
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "cancelled": false,
      "check_directs": [],
      "created_date_unix": 1565814899,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [
        {
          "id": "vEw4non1WycnRQKOpREX",
          "discount_type": "percent",
          "discount_amount": 7,
          "discount_percent": 0.1,
          "coupon": {
            "id": "VPmmrpbVl7cQ9JaXEanl",
            "name": "10 Percent Off",
            "description": "",
            "coupon_code": "10percent"
          }
        }
      ],
      "hosted_endpoint": null,
      "hosted_page": null,
      "hosted_page_template": null,
      "hosted_page_visit": null,
      "id": "k6vnbJom00Ug89mpRj78",
      "internal_id": "sale_8970",
      "is_check_direct": false,
      "is_check_direct_pending": false,
      "is_offline_payment": false,
      "iso_currency": "USD",
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_profile": {
        "id": "ajyXm76OpjSL4p5oO2By",
        "name": "AuthBrainStripe",
        "results": {
          "declined_transaction_array": [
            "y27kOy7kblsWJX6kjb0X"
          ],
          "final_amount": 111.86,
          "num_declined_transactions": 1,
          "original_amount": 124.29,
          "payment_profile_id": "ajyXm76OpjSL4p5oO2By",
          "step_array": [
            {
              "step_action": "initial",
              "step_amount": 124.29,
              "step_cascade_result": {
                "cascade_order": "sort_order",
                "enabled_gateways": [
                  "2rE2pQGMd7SYjGp42yEL",
                  "LYE26MW8Rlh5VbJmlp2l",
                  "GOJankNpkpsPzw6No1OP",
                  "NkAMJOzpB5iEAOrdloV0"
                ],
                "gateway_results": [
                  {
                    "gateway_id": "2rE2pQGMd7SYjGp42yEL",
                    "order": 1,
                    "revenue_rules": {
                      "enabled": false,
                      "passed": true,
                      "details": []
                    },
                    "success": true,
                    "time_rules": {
                      "enabled": false,
                      "passed": true,
                      "details": []
                    }
                  }
                ],
                "start_gateway": "2rE2pQGMd7SYjGp42yEL"
              },
              "step_gateway": "Worldpay",
              "step_gateway_id": "2rE2pQGMd7SYjGp42yEL",
              "step_gateway_response": "",
              "step_modifier": "",
              "step_num": 1,
              "step_result": "Declined",
              "step_setting": "initial",
              "step_source": "cascade",
              "step_transaction": "y27kOy7kblsWJX6kjb0X"
            },
            {
              "step_action": "next",
              "step_amount": 111.86,
              "step_cascade_result": null,
              "step_gateway": "Braintree",
              "step_gateway_id": "NkAMJOzpB5iEAOrdloV0",
              "step_modifier": "10",
              "step_num": 2,
              "step_result": "Approved",
              "step_setting": "modifypct",
              "step_source": "gateway",
              "step_transaction": "ALRjyqRE27fjMonyKLny"
            }
          ],
          "successful_gateway": "Braintree",
          "successful_step_num": 2
        }
      },
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_payment": false,
      "pending_refunds": [],
      "product_sales": [
        "zGld6plAkacWRzRwblaJ",
        "9rdEMadyZ7uYgnbKWwX5",
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "products_detailed": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "price": 89.99,
          "quantity": 1,
          "name": "USB HDD",
          "description": "Great USB for data storage.",
          "total_amount": 89.99,
          "discount_amount": 3.75,
          "is_subscription": false,
          "is_trial": false,
          "internal_id": "usb_hdd",
          "sku": "usb_hdd_sku",
          "url": "https://mystore.com/usb-hdd",
          "images": [
            {
              "id": "2r14zlG0mjF5zbQ24XAl",
              "featured": true,
              "file_name": "2r14zlG0mjF5zbQ24XAl",
              "file_ext": "jpg",
              "image_width": 612,
              "image_height": 612,
              "mimetype": "image/jpeg",
              "base_url": "https://productimg.revcent.com",
              "full_url": "https://productimg.revcent.com/2r14zlG0mjF5zbQ24XAl.jpg",
              "compressed_extensions": [
                "_resize_150",
                "_resize_600",
                "_resize_300"
              ]
            }
          ]
        }
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "ship_to": {
        "first_name": "ahux",
        "last_name": "qtrpinkz",
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "city": "Washington",
        "state": "DC",
        "zip": "20500",
        "country": "USA",
        "company": "",
        "email": "bwbb@gmail.com",
        "phone": "1234567890"
      },
      "shipping": [
        "gYamRbaGZphKn8zJVow1"
      ],
      "shipping_amount": 5,
      "smtp_messages": [],
      "status": "Partially Captured",
      "subscription_renewals": [],
      "subscriptions": [
        "WmPnWqPKbpFRmy6Ma2BG",
        "o1jGw5jY2RILLl4dBMwa"
      ],
      "tax": [
        "ALRjyqRE27fjjpmRzBRd"
      ],
      "tax_amount": 9.31,
      "third_party_shop": null,
      "tracking_visitor": null,
      "transactions": [
        "ALRjyqRE27fjMonyKLny"
      ],
      "trials": [
        "LY5yop5nk7hb6o2Pvl5j"
      ],
      "unique_request_id": "dfbea91e6f26358e0ed3b9127bf8647b",
      "updated_date_unix": 1565814901
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="sale-search" data-ordernum="111"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text sale-search"><h3>Sale Search</h3><hr></hr><p>Search for a sale using a string or group of strings.<br> Please read more about <a href="https://kb.revcent.com/en/integrations/revcent-api/api-search" target="_blank">API Search <i class="far fa-external-link-square-alt small"></i></a> before proceeding.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">search_term<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The string to search.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">item_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">highlights<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">field<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">values<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">score<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="sale-search-request" class="highlight-code language-json ">{
  "request": {
    "type": "sale",
    "method": "search",
    "search_term": "vvheijtwb"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="sale-search-response" class="highlight-code language-json ">{
  "api_call_id": "O0EOrOWWvaiY6N9opdLQ",
  "api_call_processed": true,
  "api_call_unix": 1681236956,
  "code": 1,
  "request_method": "search",
  "request_type": "sale",
  "results": [
    {
      "item_type": "sale",
      "id": "nbpAJjqylZcqWZmrVL4X",
      "created_date_unix": 1681154305,
      "customer_id": "j0wbkvqM57ijYNMZLzBv",
      "first_name": "injl",
      "last_name": "vvheijtw",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "email": "oymy32@gmail.com",
      "phone": "4041242229",
      "ship_to_first_name": "injlb",
      "ship_to_last_name": "vvheijtwb",
      "ship_to_address_line_1": "1600 Pennsylvania Ave",
      "ship_to_address_line_2": "",
      "ship_to_city": "Washington",
      "ship_to_state": "DC",
      "ship_to_zip": "20500",
      "ip_address": "123.456.789.0",
      "metadata": [],
      "url": "https://revcent.com/user/sale-details/nbpAJjqylZcqWZmrVL4X",
      "highlights": [
        {
          "field": "last_name",
          "values": [
            "vvheijtw"
          ]
        },
        {
          "field": "ship_to_last_name",
          "values": [
            "vvheijtwb"
          ]
        }
      ],
      "score": 9.658517837524414
    }
  ]
}</pre></div></div></div></section><section id="salvage-transaction" data-ordernum="112"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text salvage-transaction"><h2>Salvage Transaction</h2><hr></hr><p>A salvage transaction is a fully or partially declined credit card transaction. We save all submitted customer information regardless if a credit card transaction is declined.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="salvage-transaction-process" data-ordernum="113"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text salvage-transaction-process"><h3>Salvage Transaction Process</h3><hr></hr><p>Manually process a salvage transaction. RevCent can automatically process salvage transactions using <a href="https://kb.revcent.com/en/payments/credit-card/salvage-transaction#salvage-transaction-profile" target="_blank">Salvage Profiles</a>.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_card_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish the try a specific customer card, provide the cards' RevCent ID. Otherwise do not include this property to use the salvage transaction customer's default card.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment object. Contains the credit_card object. If not present the existing default payment method associated with the related customer will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">credit_card<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit_card object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">card_number<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card number. This value must be a valid credit card number as a string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_month<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration month. Two digit integer, MM.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">exp_year<div class="integer-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card expiration year. Two digit integer, YY.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_code<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The credit card code as a string. Depending on the card type this can be different lengths.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">set_as_default<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">bill_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>To use as the billing information. If not present the customer object will be used.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success<br>2 = Merchant Declined<br>3 = Merchant Error<br>4 = Merchant Hold<br>5 = Fraud Detected<br></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The full response from the merchant gateway as a JSON string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the credit card transaction.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="salvage-transaction-process-request" class="highlight-code language-json ">{
  "request": {
    "type": "salvage_transaction",
    "method": "process",
    "salvage_transaction_id": "VPm9Mqmgw7UJJLldojJY"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="salvage-transaction-process-response" class="highlight-code language-json ">{
  "amount": 12.43,
  "api_call_id": "RJ5MnkJqa8CGGjRlAJmn",
  "api_call_processed": true,
  "api_call_unix": 1565814918,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "card_id": "1rQA58w6XXcMNRApYLPn",
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "georgew@whitehouse.com",
    "enabled": true,
    "first_name": "George",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "pres_0001",
    "last_name": "Washington",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "gateway": "Braintree",
  "gateway_id": "NkAMJOzpB5iEAOrdloV0",
  "gateway_raw_response": "",
  "request_method": "process",
  "request_type": "salvage_transaction",
  "result": "Approved",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "salvage_transaction_id": "VPm9Mqmgw7UJJLldojJY",
  "transaction_id": "ajOA902JAdcpM4lEZNGQ"
}</pre></div></div></div></section><section id="salvage-transaction-retrieve" data-ordernum="114"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text salvage-transaction-retrieve"><h3>Salvage Transaction Retrieve</h3><hr></hr><p>Retrieve current information on a single salvage transaction or multiple salvage transactions.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_charged<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount successfully charged in the originating transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the salvage transaction is enabled, thus able to be processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway which originated the salvage transaction</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the gateway which originated the salvage transaction</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_payment_profile<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is related to a payment profile transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_subscription_renewal<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is related to a failed subscription renewal transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_retries<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total number of salvage attempts.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment profile related to the salvage transaction.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment profile ID to the salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment profile name to the salvage transaction.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_partial<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the payment profile resulted in a partial transaction or a full decline.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of the sale associated with the salvage transaction, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_creator<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the salvage transaction will create a new sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_initial<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the salvage transaction is part of an initial sale transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvaged<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the salvage transaction was successfully processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success_transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The transaction ID of a successful salvage.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="salvage-transaction-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "salvage_transaction",
    "method": "retrieve",
    "id": "VPm9Mqmgw7UJJLldojJY"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="salvage-transaction-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "JN58oyLWgpCEErknYgRz",
  "api_call_processed": true,
  "api_call_unix": 1565814915,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "salvage_transaction",
  "results": [
    {
      "amount_charged": 111.86,
      "amount_original_total": 124.29,
      "amount_to_salvage": 12.43,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "enabled": true,
      "gateway_id": "NkAMJOzpB5iEAOrdloV0",
      "gateway_name": "Braintree",
      "id": "VPm9Mqmgw7UJJLldojJY",
      "is_payment_profile": true,
      "is_subscription_renewal": false,
      "live_mode": false,
      "notes": [],
      "num_retries": 0,
      "offline_payments": [],
      "payment_profile": {
        "id": "ajyXm76OpjSL4p5oO2By",
        "name": "AuthBrainStripe"
      },
      "payment_profile_partial": true,
      "paypal_transactions": [],
      "pending_refunds": [
        "MW5LoA9WlLIwV9OErYOk"
      ],
      "product_sales": [
        "zGld6plAkacWRzRwblaJ",
        "9rdEMadyZ7uYgnbKWwX5",
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "sale_amount_total": 274.28,
      "sale_creator": false,
      "sale_initial": true,
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvaged": false,
      "shipping": [
        "gYamRbaGZphKn8zJVow1"
      ],
      "smtp_messages": [],
      "status": "Ready",
      "subscription_renewals": [],
      "subscriptions": [],
      "success_transaction_id": null,
      "tax": [
        "ALRjyqRE27fjjpmRzBRd"
      ],
      "transactions": [
        "ALRjyqRE27fjMonyKLny"
      ],
      "trials": [],
      "updated_date_unix": 1565814906
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="settlement" data-ordernum="115"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text settlement"><h2>Settlement</h2><hr></hr><p>A settlement in RevCent can be created automatically, via webhook function, or via the API. Read more about settlements at our <a href="https://kb.revcent.com/en/payments/settlement" target="_blank">Knowledge Base</a>.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="settlement-create" data-ordernum="116"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text settlement-create"><h3>Settlement Create</h3><hr></hr><p>Create a settlement in RevCent. Requires that you provide either the RevCent gateway ID or merchant account ID to link a settlement to a gateway.<br>If providing the merchant_account_id in the request, make sure the related gateway in RevCent has a merchant account ID assigned to it.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent gateway ID the settlement is related to. Either the gateway_id or merchant_account_id is required.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>If not providing the gateway_id property, then the provide the merchant account ID associated with the gateway. Make sure the related gateway in RevCent has a merchant account ID assigned to it.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The settlement amount, i.e. what is being deposited into your bank.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_settlement_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The settlement ID from the gateway. This is to be unique within your RevCent account.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_settlement_date<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The settlement date from the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code. If not provided default is 'USD'.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_settlement_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_settlement_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success<br>2 = Merchant Declined<br>3 = Merchant Error<br>4 = Merchant Hold<br>5 = Fraud Detected<br></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">settlement_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="settlement-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "settlement",
    "method": "create",
    "merchant_account_id": "12345",
    "amount": 100.34,
    "gateway_settlement_id": "stl_343339",
    "gateway_settlement_date": "2023-07-19T14:41:54"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="settlement-create-response" class="highlight-code language-json ">{
  "amount": 100.34,
  "api_call_date": "2023-07-19T15:00:43+00:00",
  "api_call_id": "4r42Q8XvqaUq6Rjw5rE9",
  "api_call_processed": true,
  "api_call_unix": 1689778843,
  "code": 1,
  "gateway_settlement_date": "2023-07-19T14:41:54.000Z",
  "gateway_settlement_id": "stl_343339",
  "request_method": "create",
  "request_type": "settlement",
  "result": "Settlement created.",
  "settlement_id": "ALz87ylN41UrdzBwonLn"
}</pre></div></div></div></section><section id="settlement-retrieve" data-ordernum="117"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text settlement-retrieve"><h3>Settlement Retrieve</h3><hr></hr><p>Retrieve current information on a single settlement or multiple settlements. Only the date and gateway filter is supported.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">merchant_account_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The merchant account ID associated with the merchant gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_gateway<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_settlement_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">iso_currency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>ISO 4217 currency code.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="settlement-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "settlement",
    "method": "retrieve",
    "id": "ALz87ylN41UrdzBwonLn"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="settlement-retrieve-response" class="highlight-code language-json ">{
  "amount": 100.34,
  "created_date_unix": 1689777714,
  "gateway": {
    "id": "gYVMVngL9XSn1Gl60oJM",
    "name": "New Auth20",
    "merchant_account_id": "12345",
    "site_gateway": {
      "id": "dXAmybdWwYHrLyWRAAZV",
      "name": "Authorize.net"
    }
  },
  "gateway_settlement_id": "stl_343339",
  "id": "ALz87ylN41UrdzBwonLn",
  "iso_currency": "USD",
  "payment_type": {
    "id": "KnQ0KlNE6kf5mobyV0pN",
    "name": "Credit Card"
  },
  "updated_date_unix": 1689777714
}</pre></div></div></div></section><section id="shipping" data-ordernum="118"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text shipping"><h2>Shipping</h2><hr></hr><p>A shipping is a completely isolated part of a sale. Each shipping is its own entity capable of separate transactions and tracking</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="shipping-edit" data-ordernum="119"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text shipping-edit"><h3>Shipping Edit</h3><hr></hr><p>Modify shipping information for a specific shipment.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>A description of the shipping.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">free_shipping<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicated whether this is a free shipping item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to modify the ship_to info.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipped<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the shipment has been shipped.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">delivered<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the shipment has been delivered.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">send_notification<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to send a notification to the customer upon modification. Useful when editing a shipping item as shipped and wishing to let the customer know. Default: false.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">weight<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the shipping.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="shipping-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "shipping",
    "method": "edit",
    "shipping_id": "gYamRbaGZphKn8zJVow1",
    "provider": "ups",
    "provider_method": "overnight",
    "provider_tracking": "1Z9999999999999999",
    "weight": 41.3,
    "shipped": false,
    "delivered": false,
    "send_notification": false,
    "ship_to": {
      "first_name": "dzwy",
      "last_name": "vloavpxc",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "sgzt@gmail.com",
      "phone": "1234567890"
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="shipping-edit-response" class="highlight-code language-json ">{
  "api_call_id": "mJGAbQoJ6Ai12kV8gQ0E",
  "api_call_processed": true,
  "api_call_unix": 1565814906,
  "code": 1,
  "request_method": "edit",
  "request_type": "shipping",
  "result": "Shipping information successfully edited.",
  "shipping_id": "gYamRbaGZphKn8zJVow1"
}</pre></div></div></div></section><section id="shipping-refund" data-ordernum="120"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text shipping-refund"><h3>Shipping Refund</h3><hr></hr><p>Refund a shipment for a specific amount or entire amount.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount to refund. If not provided the entire shipping amount will be refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the shipping.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each pending refund created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the shipping.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="shipping-refund-request" class="highlight-code language-json ">{
  "request": {
    "type": "shipping",
    "method": "refund",
    "shipping_id": "gYamRbaGZphKn8zJVow1",
    "amount": 4.25
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="shipping-refund-response" class="highlight-code language-json ">{
  "amount": 4.25,
  "api_call_id": "rm9EA5ymgEIoKZMq74BZ",
  "api_call_processed": true,
  "api_call_unix": 1565814906,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "pending_refund": [
    "MW5LoA9WlLIwV9OErYOk"
  ],
  "request_method": "refund",
  "request_type": "shipping",
  "result": "Shipping refunded in the amount of $4.25.",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "shipping_id": "gYamRbaGZphKn8zJVow1"
}</pre></div></div></div></section><section id="shipping-retrieve" data-ordernum="121"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text shipping-retrieve"><h3>Shipping Retrieve</h3><hr></hr><p>Retrieve current information on a single shipping item or multiple shipping items.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_discounted<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount discounted.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any refunds.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_settled<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount settled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_void<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any items that have been voided.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">complete<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">cost<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Any cost value provided when creating the shipping item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_notification<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer notification object provides information on if the customer was notified upon certain shipping events.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">notified_shipped<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the customer was notified when the item shipped.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">notified_delivered<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the customer was notified when the item was delivered.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fulfillment_account<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fulfillment account associated with the shipping item, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_check_direct<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the item was created using a check_direct payment method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_delivered<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the shipping item was delivered.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_free<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the shipping item was indicated as free shipping when created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_offline_payment<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the item was created using an offline payment method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_received<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_shipped<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the shipping item was shipped.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products_detailed<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Products detailed is an array of individual product objects, indicating the products which were contained in each shipping item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product SKU.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product internal ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">list_price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The list price of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">percent_of_shipping<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The weighted price of the product compared to other products.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sale price of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The sale quantity of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total sale amount of the product. Price x Quantity.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_delivered_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider delivered date.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_received_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking number or ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The shipping provider tracking URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_update_error<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether there was an error when updating information about the shipping from the shipping provider, using the provider_tracking.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_update_last_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last date in unix timestamp that RevCent acquired an update from the provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_update_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The latest response that RevCent received when requesting an update from the provider.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">send_notification<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the customer will receive a notification for this shipping item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the shipping was shipped.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ship to object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current shipping status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate calculated based on tax amount and total related item amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">weight<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Deprecated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="shipping-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "shipping",
    "method": "retrieve",
    "id": "gYamRbaGZphKn8zJVow1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="shipping-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "JN58oy4OPWsEb7JXLMMB",
  "api_call_processed": true,
  "api_call_unix": 1565814906,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "shipping",
  "results": [
    {
      "amount_captured": 4.94,
      "amount_discounted": 0,
      "amount_fees": 0.13,
      "amount_gross": 4.94,
      "amount_net": 4.81,
      "amount_original_total": 5,
      "amount_refunded": 0.06,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_to_salvage": 0,
      "amount_total": 4.94,
      "amount_void": 0,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "complete": false,
      "cost": 0,
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "customer_notification": {
        "customer": {
          "notified_shipped": false,
          "notified_delivered": false
        }
      },
      "description": "",
      "discounts": [],
      "fulfillment_account": {
        "id": "j0o25b2YJRFdJb8EEXE1",
        "name": "ShipWorks"
      },
      "id": "gYamRbaGZphKn8zJVow1",
      "is_check_direct": false,
      "is_delivered": false,
      "is_free": false,
      "is_offline_payment": false,
      "is_received": false,
      "is_shipped": false,
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "name": "usps priority",
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [
        "Nk5voyEw8YiOmaRvjgyG"
      ],
      "product_sales": [
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "products_detailed": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "name": "USB HDD",
          "description": "Great USB for data storage.",
          "internal_id": "13",
          "sku": "usb_hdd",
          "url": "https://mystore.com/usb-hdd",
          "list_price": 89.99,
          "percent_of_shipping": 1,
          "price": 89.99,
          "quantity": 1,
          "total_amount": 89.99,
          "images": [
            {
              "id": "2r14zlG0mjF5zbQ24XAl",
              "featured": true,
              "file_name": "2r14zlG0mjF5zbQ24XAl",
              "file_ext": "jpg",
              "image_width": 612,
              "image_height": 612,
              "mimetype": "image/jpeg",
              "base_url": "https://productimg.revcent.com",
              "full_url": "https://productimg.revcent.com/2r14zlG0mjF5zbQ24XAl.jpg",
              "compressed_extensions": [
                "_resize_150",
                "_resize_600",
                "_resize_300"
              ]
            }
          ]
        }
      ],
      "provider": "usps",
      "provider_delivered_date_unix": null,
      "provider_method": "priority_mail",
      "provider_received_date_unix": null,
      "provider_tracking": "4095511206218844523600",
      "provider_tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=4095511206218844523600",
      "provider_update_error": false,
      "provider_update_last_unix": null,
      "provider_update_response": null,
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "send_notification": true,
      "ship_date_unix": null,
      "ship_to": {
        "first_name": "ahux",
        "last_name": "qtrpinkz",
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "city": "Washington",
        "state": "DC",
        "zip": "20500",
        "country": "USA",
        "company": "",
        "email": "bwbb@gmail.com",
        "phone": "1234567890"
      },
      "shipping_status": "Not Shipped",
      "smtp_messages": [],
      "status": "Fully Captured with Refund",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [
        "ALRjyqRE27fjjpmRzBRd"
      ],
      "tax_rate": 0.08,
      "third_party_shop": null,
      "transactions": [
        "ALRjyqRE27fjMonyKLny"
      ],
      "trials": [],
      "updated_date_unix": 1565814903,
      "weight": 0
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="shipping-search" data-ordernum="122"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text shipping-search"><h3>Shipping Search</h3><hr></hr><p>Search for a shipment using a string or group of strings.<br> Please read more about <a href="https://kb.revcent.com/en/integrations/revcent-api/api-search" target="_blank">API Search <i class="far fa-external-link-square-alt small"></i></a> before proceeding.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">search_term<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The string to search.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">item_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to_zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">provider_tracking<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_date_unix<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">delivered_date_unix<div class="null-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">highlights<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">field<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">values<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">score<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="shipping-search-request" class="highlight-code language-json ">{
  "request": {
    "type": "shipping",
    "method": "search",
    "search_term": "qZmZZGBdnMSkk2XZmnAE"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="shipping-search-response" class="highlight-code language-json ">{
  "api_call_id": "8r0za5qEdnHb10p2domz",
  "api_call_processed": true,
  "api_call_unix": 1681160327,
  "code": 1,
  "request_type": "shipping",
  "request_method": "search",
  "results": [
    {
      "item_type": "shipping",
      "id": "qZmZZGBdnMSkk2XZmnAE",
      "created_date_unix": 1680909460,
      "ship_to_first_name": "Georgeb",
      "ship_to_last_name": "Washington",
      "ship_to_address_line_1": "1600 Pennsylvania Ave",
      "ship_to_address_line_2": "",
      "ship_to_city": "Washington",
      "ship_to_state": "DC",
      "ship_to_zip": "20500",
      "provider": "UPS",
      "provider_method": "ups_2nd_day_air",
      "provider_tracking": "",
      "shipping_status": "Not Shipped",
      "ship_date_unix": null,
      "delivered_date_unix": null,
      "metadata": [],
      "url": "https://revcent.com/user/shipping-details/qZmZZGBdnMSkk2XZmnAE",
      "highlights": [
        {
          "field": "id",
          "values": [
            "qZmZZGBdnMSkk2XZmnAE"
          ]
        }
      ],
      "score": 7.39
    }
  ]
}</pre></div></div></div></section><section id="shop" data-ordernum="123"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text shop"><h1>Shop</h1><hr></hr><p>RevCent has different shop entities. The site shop and user shop.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="site-shop" data-ordernum="124"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text site-shop"><h2>Site Shop</h2><hr></hr><p>A site shop is the underlying software/system/service that is powering your online ecommerce store. You create a user shop based on a site shop.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="site-shop-retrieve" data-ordernum="125"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text site-shop-retrieve"><h3>Site Shop Retrieve</h3><hr></hr><p>Retrieve current information on a single site shop or multiple site shops. This is the list of available external shops within the RevCent system. The most important part is the fields array, which is what each shop requires for authentication.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">required<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="site-shop-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "site_shop",
    "method": "retrieve",
    "id": "ajr7dJkNkoS1gEp5jw1k",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="site-shop-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "ZVA8a1XYMJuMnnP1BMyZ",
  "api_call_processed": true,
  "api_call_unix": 1676946618,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "site_shop",
  "results": [
    {
      "description": "The WooCommerce API requires both a consumer_key and consumer_secret. Both can be created in your WordPress admin panel by navigating to WooCommerce > Settings > Advanced > REST API",
      "fields": [
        {
          "id": "consumer_key",
          "description": "Consumer key",
          "required": true
        },
        {
          "id": "consumer_secret",
          "description": "Consumer secret",
          "required": true
        }
      ],
      "id": "ajr7dJkNkoS1gEp5jw1k",
      "name": "WooCommerce"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="user-shop" data-ordernum="126"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-shop"><h2>User Shop</h2><hr></hr><p>You create a user shop based on a site shop.<br><br>For example, if you are creating a user shop for WooCommerce, you would need to supply the correct number of fields, including each fields' corresponding id and value when creating the user shop. In the case of WooCommerce you would need to supply both the consumer_key and consumer_secret as shown in the example JSON.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="user-shop-create" data-ordernum="127"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-shop-create"><h3>User Shop Create</h3><hr></hr><p>Create a user shop within RevCent via the user shop create method. RevCent will automatically connect to your shop and update any necessary settings to the RevCent plugin.<br><br><strong>WooCommerce Users</strong>: Make sure you have completed the following:<br><ol><li>Installed and enabled the RevCent plugin. <a href="https://kb.revcent.com/en/integrations/third-party-shop/woocommerce-installation#install-wordpress-plugin" target="_blank">More info <i class="far fa-external-link-square-alt small"></i></a>.</li><li>Created a REST api key with both the consumer_key and consumer_secret. <a href="https://kb.revcent.com/en/integrations/third-party-shop/woocommerce-installation#create-a-woocommerce-api-key" target="_blank">More info <i class="far fa-external-link-square-alt small"></i></a></li></ol></p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shop name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shop description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_shop_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent site shop ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_shop_version<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The version of the shop software.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to process payment requests coming from the shop as live or test.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment profile ID to associate with the shop</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign ID to associate with the shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each containing the id and value of the fields corresponding to the site shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The id for the individual field according to the site shop fields required.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value for the individual field according to the site shop fields required.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_account<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields_saved<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_hosted<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Payment profile related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_version<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">required<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">version<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">webhook<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="user-shop-create-request" class="highlight-code language-json ">{
  "request": {
    "type": "user_shop",
    "method": "create",
    "name": "New Shop",
    "description": "Original description.",
    "url": "newshop.com",
    "site_shop_id": "ajr7dJkNkoS1gEp5jw1k",
    "site_shop_version": "3",
    "live_mode": false,
    "payment_profile_id": "o1zXNj9RqztqbLKWGk4L",
    "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
    "fields": [
      {
        "id": "consumer_key",
        "value": "ck_12342555"
      },
      {
        "id": "consumer_secret",
        "value": "cs_12124441"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="user-shop-create-response" class="highlight-code language-json ">{
  "api_account": {
    "id": "rmNgKq408RT0q5gNpdpV",
    "name": "API Account for New Shop"
  },
  "api_call_date": "2023-02-21T02:20:17+00:00",
  "api_call_id": "bOpMjqLVPvHV9ERLlPzj",
  "api_call_processed": true,
  "api_call_unix": 1676946017,
  "campaign": {
    "id": "mJ1zZoOobEuP8pnWKXd1",
    "name": "Adwords Campaign"
  },
  "code": 1,
  "created_date": "2023-02-21T02:20:13+00:00",
  "created_date_unix": 1676946013,
  "description": "Original description.",
  "enabled": true,
  "fields_saved": [
    "consumer_key",
    "consumer_secret"
  ],
  "id": "y24rXwQPGNfdMAQbmpmG",
  "is_hosted": false,
  "live_mode": false,
  "name": "New Shop",
  "payment_profile": {
    "id": "o1zXNj9RqztqbLKWGk4L",
    "name": "Stripe Only"
  },
  "request_method": "create",
  "request_type": "user_shop",
  "result": "Shop created.",
  "shop_version": "3",
  "site_shop": {
    "id": "ajr7dJkNkoS1gEp5jw1k",
    "name": "WooCommerce",
    "description": "The WooCommerce API requires both a consumer_key and consumer_secret. Both can be created in your WordPress admin panel by navigating to WooCommerce > Settings > Advanced > REST API",
    "fields": [
      {
        "id": "consumer_key",
        "description": "Consumer key",
        "required": true
      },
      {
        "id": "consumer_secret",
        "description": "Consumer secret",
        "required": true
      }
    ],
    "version": "3"
  },
  "updated_date": "2023-02-21T02:20:17+00:00",
  "updated_date_unix": 1676946017,
  "url": "newshop.com",
  "webhook": {
    "id": "qZ91gqaG0bukOq7QKvKY",
    "name": "Webhook for New Shop"
  }
}</pre></div></div></div></section><section id="user-shop-edit" data-ordernum="128"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-shop-edit"><h3>User Shop Edit</h3><hr></hr><p>Edit an existing user shop within RevCent via the user shop edit method. RevCent will automatically connect to your shop and update any necessary settings to the RevCent plugin.<br><br><strong>Note:</strong> Only provide the properties you wish to modify. Properties not provided will remain unchanged.<br><br><strong>Important</strong>: If updating the shop fields, you must provide the site_shop_id property as well.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_shop_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the shop you are editing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shop name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Shop description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_shop_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent site shop ID. Required if providing the fields property.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_shop_version<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The version of the shop software.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether to process payment requests coming from the shop as live or test.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment profile ID to associate with the shop</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign ID to associate with the shop.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each containing the id and value of the fields corresponding to the site shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The id for the individual field according to the site shop fields required.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">value<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The value for the individual field according to the site shop fields required.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_account<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields_saved<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_hosted<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Payment profile related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_version<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">required<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">version<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">webhook<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="user-shop-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "user_shop",
    "method": "edit",
    "user_shop_id": "y24rXwQPGNfdMAQbmpmG",
    "name": "New Shop Updated",
    "description": "Updated description.",
    "url": "newshop.com",
    "site_shop_id": "ajr7dJkNkoS1gEp5jw1k",
    "site_shop_version": "3",
    "live_mode": false,
    "payment_profile_id": "o1zXNj9RqztqbLKWGk4L",
    "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
    "fields": [
      {
        "id": "consumer_key",
        "value": "ck_12342555"
      },
      {
        "id": "consumer_secret",
        "value": "cs_12124441"
      }
    ]
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="user-shop-edit-response" class="highlight-code language-json ">{
  "api_account": {
    "id": "rmNgKq408RT0q5gNpdpV",
    "name": "API Account for New Shop Updated"
  },
  "api_call_date": "2023-02-21T02:20:37+00:00",
  "api_call_id": "gYVNnZ5kl4hXkjqpOmOg",
  "api_call_processed": true,
  "api_call_unix": 1676946037,
  "campaign": {
    "id": "mJ1zZoOobEuP8pnWKXd1",
    "name": "Adwords Campaign"
  },
  "code": 1,
  "created_date": "2023-02-21T02:20:13+00:00",
  "created_date_unix": 1676946013,
  "description": "Updated description.",
  "enabled": true,
  "fields_saved": [
    "consumer_key",
    "consumer_secret"
  ],
  "id": "y24rXwQPGNfdMAQbmpmG",
  "is_hosted": false,
  "live_mode": false,
  "name": "New Shop Updated",
  "payment_profile": {
    "id": "o1zXNj9RqztqbLKWGk4L",
    "name": "Stripe Only"
  },
  "request_method": "edit",
  "request_type": "user_shop",
  "result": "Shop edited.",
  "shop_version": "3",
  "site_shop": {
    "id": "ajr7dJkNkoS1gEp5jw1k",
    "name": "WooCommerce",
    "description": "The WooCommerce API requires both a consumer_key and consumer_secret. Both can be created in your WordPress admin panel by navigating to WooCommerce > Settings > Advanced > REST API",
    "fields": [
      {
        "id": "consumer_key",
        "description": "Consumer key",
        "required": true
      },
      {
        "id": "consumer_secret",
        "description": "Consumer secret",
        "required": true
      }
    ],
    "version": "3"
  },
  "updated_date": "2023-02-21T02:20:37+00:00",
  "updated_date_unix": 1676946037,
  "url": "newshop.com",
  "webhook": {
    "id": "qZ91gqaG0bukOq7QKvKY",
    "name": "Webhook for New Shop Updated"
  }
}</pre></div></div></div></section><section id="user-shop-validate" data-ordernum="129"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-shop-validate"><h3>User Shop Validate</h3><hr></hr><p>Validate an existing user shop within RevCent via the user shop validate method. RevCent will connect to your shop and check the RevCent plugin settings. Any issues will be returned as an error.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_shop_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the shop.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">error_code<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">message<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="user-shop-validate-request" class="highlight-code language-json ">{
  "request": {
    "type": "user_shop",
    "method": "validate",
    "user_shop_id": "j02ZrRQqKNUrOwYmmbG0"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="user-shop-validate-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-21T21:12:54+00:00",
  "api_call_id": "RJ0yPbpkloT5Vvd6WYRn",
  "api_call_processed": true,
  "api_call_unix": 1677013974,
  "code": 0,
  "error_code": "E0668",
  "message": "The RevCent plugin is installed but not properly set up. Try running the fix method.",
  "request_method": "validate",
  "request_type": "user_shop",
  "result": "Error"
}</pre></div></div></div></section><section id="user-shop-fix" data-ordernum="130"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-shop-fix"><h3>User Shop Fix</h3><hr></hr><p>Fix an existing user shop within RevCent via the user shop fix method. RevCent will connect to your shop, check the RevCent plugin settings and attempt to fix any issues. Any remaining issues that could not be fixed will be returned as an error.<br><br><strong>Note:</strong> This method is only intended to fix the required settings for the RevCent plugin, not issues unrelated to RevCent. I.e. this will not fix other plugin issues or store code.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_shop_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the shop.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="user-shop-fix-request" class="highlight-code language-json ">{
  "request": {
    "type": "user_shop",
    "method": "fix",
    "user_shop_id": "j02ZrRQqKNUrOwYmmbG0"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="user-shop-fix-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-21T21:34:20+00:00",
  "api_call_id": "VPbzXEpmz5tL2PE205qV",
  "api_call_processed": true,
  "api_call_unix": 1677015260,
  "code": 1,
  "request_method": "fix",
  "request_type": "user_shop",
  "result": "Congratulations! Shop is installed and properly set up."
}</pre></div></div></div></section><section id="user-shop-retrieve" data-ordernum="131"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text user-shop-retrieve"><h3>User Shop Retrieve</h3><hr></hr><p>Retrieve current information on a single user shop or multiple user shops.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_account<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The campaign object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields_saved<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_hosted<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Payment profile related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_version<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">site_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fields<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">required<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">version<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">webhook<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="user-shop-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "user_shop",
    "method": "retrieve",
    "id": "y24rXwQPGNfdMAQbmpmG",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1,
      "status_filter": [
        "enabled"
      ]
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="user-shop-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "bOpMjZkRGrSPrrBJnPmq",
  "api_call_processed": true,
  "api_call_unix": 1676946604,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "user_shop",
  "results": [
    {
      "api_account": {
        "id": "rmNgKq408RT0q5gNpdpV",
        "name": "API Account for New Shop"
      },
      "campaign": {
        "id": "mJ1zZoOobEuP8pnWKXd1",
        "name": "Adwords Campaign"
      },
      "created_date_unix": 1676946013,
      "description": "Auth desc",
      "enabled": true,
      "fields_saved": [
        "consumer_key",
        "consumer_secret"
      ],
      "id": "y24rXwQPGNfdMAQbmpmG",
      "is_hosted": false,
      "live_mode": false,
      "name": "New Shop",
      "payment_profile": {
        "id": "o1zXNj9RqztqbLKWGk4L",
        "name": "Stripe Only"
      },
      "shop_version": "3",
      "site_shop": {
        "id": "ajr7dJkNkoS1gEp5jw1k",
        "name": "WooCommerce",
        "description": "The WooCommerce API requires both a consumer_key and consumer_secret. Both can be created in your WordPress admin panel by navigating to WooCommerce > Settings > Advanced > REST API",
        "fields": [
          {
            "id": "consumer_key",
            "description": "Consumer key",
            "required": true
          },
          {
            "id": "consumer_secret",
            "description": "Consumer secret",
            "required": true
          }
        ],
        "version": "3"
      },
      "updated_date_unix": 1676946037,
      "url": "newshop.com",
      "webhook": {
        "id": "qZ91gqaG0bukOq7QKvKY",
        "name": "Webhook for New Shop"
      }
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="subscription" data-ordernum="132"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription"><h2>Subscription</h2><hr></hr><p>Subscriptions are automatically charged based on the subscription profile associated with a subscription. RevCent only supports credit card payment types for subscriptions at this time. RevCent automatically processes renewals, however you have the ability to manually process them as well.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="subscription-activate" data-ordernum="133"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-activate"><h3>Subscription Activate</h3><hr></hr><p>Activate a previously suspended subscription.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The subscription ID</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the trial.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="subscription-activate-request" class="highlight-code language-json ">{
  "request": {
    "type": "subscription",
    "method": "activate",
    "subscription_id": "WmPnWqPKbpFRmy6Ma2BG"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="subscription-activate-response" class="highlight-code language-json ">{
  "api_call_id": "MW5LoArYGnHww6EPNAjO",
  "api_call_processed": true,
  "api_call_unix": 1565814914,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "request_method": "activate",
  "request_type": "subscription",
  "result": "Subscription activated.",
  "subscription_id": "WmPnWqPKbpFRmy6Ma2BG",
  "trial_id": null
}</pre></div></div></div></section><section id="subscription-suspend" data-ordernum="134"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-suspend"><h3>Subscription Suspend</h3><hr></hr><p>Suspend a subscription, preventing it from renewing unless reactivated.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The subscription ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">refund_product_sale<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether or not to refund the product sale related to the subscription. Default: false</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Only applies if refund_product_sale = true. If you wish to specify the amount to refund. If the amount property is not present the entire product sale amount will be refunded.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="subscription-suspend-request" class="highlight-code language-json ">{
  "request": {
    "type": "subscription",
    "method": "suspend",
    "subscription_id": "WmPnWqPKbpFRmy6Ma2BG"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="subscription-suspend-response" class="highlight-code language-json ">{
  "api_call_id": "d9ZoKGMLXjswwPgBMY5Q",
  "api_call_processed": true,
  "api_call_unix": 1565814914,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "request_method": "suspend",
  "request_type": "subscription",
  "result": "Subscription suspended.",
  "subscription_id": "WmPnWqPKbpFRmy6Ma2BG"
}</pre></div></div></div></section><section id="subscription-cancel" data-ordernum="135"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-cancel"><h3>Subscription Cancel</h3><hr></hr><p>Cancel a subscription, preventing it from ever being renewed or reactivated.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The subscription ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">refund_product_sale<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether or not to refund the product sale related to the subscription. Default: false</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Only applies if refund_product_sale = true. If you wish to specify the amount to refund. If the amount property is not present the entire product sale amount will be refunded.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="subscription-cancel-request" class="highlight-code language-json ">{
  "request": {
    "type": "subscription",
    "method": "cancel",
    "subscription_id": "WmPnWqPKbpFRmy6Ma2BG"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="subscription-cancel-response" class="highlight-code language-json ">{
  "api_call_id": "O051o2jJPpCXbzGNgdnE",
  "api_call_processed": true,
  "api_call_unix": 1565814915,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "request_method": "cancel",
  "request_type": "subscription",
  "result": "Subscription cancelled.",
  "subscription_id": "WmPnWqPKbpFRmy6Ma2BG"
}</pre></div></div></div></section><section id="subscription-renew" data-ordernum="136"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-renew"><h3>Subscription Renew</h3><hr></hr><p>Renew a subscription manually. RevCent automatically processes renewals. Use this method if you intend to charge the customer immediately.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The subscription ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify an amount to renew. By default this is the subscription amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to specify a payment profile for processing the renewal. Default is subscription profile setting.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">update_schedule<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to update the renewal schedule. Default: true.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success<br>2 = Merchant Declined<br>3 = Merchant Error<br>4 = Merchant Hold<br>5 = Fraud Detected<br></p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The full response from the merchant gateway as a JSON string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">next_renewal_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The next subscription renewal date.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">next_renewal_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The next subscription renewal date in unix timestamp format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_results<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the payment profile used.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">original_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The original amount submitted in the request using the products, their prices and quantities.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">final_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The final amount that was successfully charged after the payment profile was applied, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step in the payment profile that ended in success, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway that successfully processed the transaction, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_declined_transactions<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of declined transactions that occurred when the payment profile was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_transaction_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of IDs for declined transactions during the payment profile processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step_array contains individual objects related to the number of steps taken in the process when implementing the payment profile.<br>We highly recommend you read more about the Payment Profile feature at RevCent to gain a better understanding of what steps are as well as step methods.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">step_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The action taken during the step.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The resulting step amount to be charged after any modifiers to payment amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_cascade_result<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of gateways used when processing the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled_gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateways which were enabled within the cascade for processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The results for each gateway validated within the cascade, after being passed or failed due to in place rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway validated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of the gateway within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all revenue rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were present and enabled, the results of the revenue validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all time rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were present and enabled, the results of the time validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all gateway validation requirements.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway which was selected first for validation.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The response returned by the gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The modifier applied to the payment amount, if any.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific step number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result of the step transaction</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step setting.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step source, either gateway or cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_transaction<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the step transaction.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific request.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction details object, if created as a result of the request. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_creator<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction will create a new sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction_created<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a salvage transaction was created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">schedule_updated<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription schedule was updated as a result of the renewal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ship to object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of shipping items created. Each object is an individual shipping item containing details.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Brief details on the subscription.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Subscription ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_overdue<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription is overdue.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_occurrence_limit<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription has reached its occurrence limit.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the subscription profile associated with the subscription.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the number of renewals allowed is specific or indefinite.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>If occurrences = specific, then the number of occurrence allowed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_specific<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription profile is specific to a single subscription. I.e. customized.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the subscription profile is specific to a single subscription, the subscription ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency setting. Either unit, calendar or fiscal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_unit<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unit based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">unit_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit value.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit, i.e. days, weeks, months or years.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_calendar<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar unit, i.e. The 2nd X of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar value, i.e. The X day of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_parent<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar parent, i.e. The 2nd day of every X</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_fiscal<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription profile.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription renewal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of tax items created. Each object is an individual tax item containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate calculated based on tax amount and total related item amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the credit card transaction.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="subscription-renew-request" class="highlight-code language-json ">{
  "request": {
    "type": "subscription",
    "method": "renew",
    "subscription_id": "WmPnWqPKbpFRmy6Ma2BG"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="subscription-renew-response" class="highlight-code language-json ">{
  "amount": 158.99,
  "amount_captured": 158.99,
  "amount_fees": 4.61,
  "amount_gross": 158.99,
  "amount_net": 154.38,
  "amount_original_total": 158.99,
  "amount_remaining": 0,
  "amount_to_salvage": 0,
  "api_call_id": "o1jGw52MyQuLpv2np5NG",
  "api_call_processed": true,
  "api_call_unix": 1565814912,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "card_id": "1rQA58w6XXcMNRApYLPn",
  "code": 1,
  "customer": {
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "cus_9299",
    "first_name": "ahux",
    "last_name": "qtrpinkz",
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "city": "Washington",
    "state": "DC",
    "zip": "20500",
    "company": "",
    "country": "USA",
    "email": "bwbb@gmail.com",
    "phone": "1234567890",
    "metadata": []
  },
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "gateway": "Stripe",
  "gateway_id": "GOJankNpkpsPzw6No1OP",
  "gateway_raw_response": "",
  "next_renewal_date": "9/14/2019",
  "next_renewal_date_unix": 1568493312,
  "payment_profile_results": {
    "payment_profile_id": "l4QbbPOQZES20A1XvjG8",
    "original_amount": 158.99,
    "final_amount": 158.99,
    "successful_step_num": 1,
    "successful_gateway": "Stripe",
    "num_declined_transactions": 0,
    "step_array": [
      {
        "step_action": "initial",
        "step_amount": 158.99,
        "step_cascade_result": null,
        "step_gateway": "Stripe",
        "step_gateway_id": "GOJankNpkpsPzw6No1OP",
        "step_modifier": "",
        "step_num": 1,
        "step_result": "Approved",
        "step_setting": "initial",
        "step_source": "gateway",
        "step_transaction": "d9ZoKG0n2pIwBG60Q6aW"
      }
    ]
  },
  "product": {
    "id": "0pBLXVZW08SNw0XOKZ7X",
    "name": "Robo Vac",
    "internal_id": "robo_vac",
    "sku": "robo_vac_sku",
    "price": 149.99,
    "quantity": 1
  },
  "request_method": "renew",
  "request_type": "subscription",
  "result": "Subscription renewal successful.",
  "salvage_transaction": null,
  "salvage_transaction_created": false,
  "schedule_updated": true,
  "ship_to": null,
  "shipping_created": [],
  "subscription": {
    "id": "WmPnWqPKbpFRmy6Ma2BG",
    "is_overdue": false,
    "is_occurrence_limit": false
  },
  "subscription_id": "WmPnWqPKbpFRmy6Ma2BG",
  "subscription_profile": {
    "id": "LYE26aKJpPi5VbJmlp2A",
    "name": "Monthly",
    "description": "",
    "occurrences": "specific",
    "occurrences_value": 3,
    "subscription_specific": false,
    "subscription_id": null,
    "frequency_unit": {
      "unit_value": 1,
      "unit": "months"
    },
    "frequency_calendar": {},
    "frequency_fiscal": {},
    "frequency": "unit"
  },
  "subscription_profile_id": "LYE26aKJpPi5VbJmlp2A",
  "subscription_renewal_id": "YaVqjA1JowiGpyEN0o55",
  "tax_created": [
    {
      "amount_original_total": 9,
      "amount_captured": 9,
      "amount_gross": 9,
      "amount_net": 8.74,
      "amount_fees": 0.26,
      "amount_remaining": 0,
      "amount_to_salvage": 0,
      "id": "y27kOyYEQ8CWWWMQQyvk",
      "name": "Tax Profile: aeega",
      "description": "",
      "rate": 0.06
    }
  ],
  "transaction_id": "d9ZoKG0n2pIwBG60Q6aW"
}</pre></div></div></div></section><section id="subscription-edit" data-ordernum="137"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-edit"><h3>Subscription Edit</h3><hr></hr><p>Edit an active subscription.<br><strong>Note:</strong> Only provide the properties you wish to modify.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The subscription ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Provide a subscription profile ID if you wish to modify the subscriptions's current profile.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">next_renewal_date<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Provide a valid date if you wish to modify the subscriptions's next renewal date.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Provide a valid amount if you wish to modify the subscriptions's amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupon<div class="array-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Provide an array of coupon ID's if you wish to attach coupons to the subscription. Provide an empty array to remove all coupons..</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>If you wish to modify the subscriptions's ship_to info.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="subscription-edit-request" class="highlight-code language-json ">{
  "request": {
    "type": "subscription",
    "method": "edit",
    "subscription_id": "WmPnWqPKbpFRmy6Ma2BG",
    "subscription_profile": "4rL19Grk10IrRgro9Qkk",
    "coupon": [
      "P65vYmp8KVCYV0R1mZ8Z"
    ],
    "amount": 19.99,
    "next_renewal_date": "12/01/2021",
    "ship_to": {
      "first_name": "ahux",
      "last_name": "qtrpinkz",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "bwbb@gmail.com",
      "phone": "1234567890"
    }
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="subscription-edit-response" class="highlight-code language-json ">{
  "api_call_date": "2023-02-01T13:54:24+00:00",
  "api_call_id": "Wm1Ak6ZwM1fR07lvbyQm",
  "api_call_processed": true,
  "api_call_unix": 1675259664,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "request_method": "edit",
  "request_type": "subscription",
  "result": "Subscription edited.",
  "subscription_id": "wL0OLGNl7acXWzdvkZ86"
}</pre></div></div></div></section><section id="subscription-retrieve" data-ordernum="138"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-retrieve"><h3>Subscription Retrieve</h3><hr></hr><p>Retrieve current information on a single subscription or multiple subscriptions.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">billing<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The billing object contains details on the last and next renewals.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">next_renewal_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The next renewal date.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">next_renewal_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The next renewal date in unix timestamp format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_renewal_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last renewal amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_renewal_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last renewal date in unix timestamp format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_renewal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last renewal ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_renewal_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The last renewal date.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">coupons<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">future_renewal_dates<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing the next 10 renewal dates, or until occurrence limit.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_active<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription is active.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_cancelled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription is cancelled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_occurrence_limit<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription has reached its occurrence limit.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_overdue<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription has one or more overdue renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_suspended<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription is suspended.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_overdue<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of overdue renewals.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products_detailed<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Products detailed is an array of individual product objects, indicating the products which are related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the product</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of the product. I.e. Price * Quantity</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product internal ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product SKU.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">images<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product images if uploaded to RevCent.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the subscription profile associated with the subscription.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the number of renewals allowed is specific or indefinite.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>If occurrences = specific, then the number of occurrence allowed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_specific<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription profile is specific to a single subscription. I.e. customized.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the subscription profile is specific to a single subscription, the subscription ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency setting. Either unit, calendar or fiscal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_unit<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unit based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">unit_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit value.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit, i.e. days, weeks, months or years.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_calendar<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar unit, i.e. The 2nd X of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar value, i.e. The X day of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_parent<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar parent, i.e. The 2nd day of every X</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_fiscal<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_start_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the subscription started.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a trial is associated with the subscription, trial details are provided within the trial object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial start date.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial end date.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial start date as a unix timestamp.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial end date as a unix timestamp.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">active<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the trial is still active.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="subscription-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "subscription",
    "method": "retrieve",
    "id": "WmPnWqPKbpFRmy6Ma2BG"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="subscription-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "7rwyEm6Yaps6ZVRZV1Yd",
  "api_call_processed": true,
  "api_call_unix": 1565814911,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "subscription",
  "results": [
    {
      "amount": 149.99,
      "billing": {
        "next_renewal_date": "2019-09-14T20:35:09+00:00",
        "next_renewal_date_unix": 1568493309,
        "last_renewal_amount": null,
        "last_renewal_date_unix": null,
        "last_renewal_id": null,
        "last_renewal_date": null
      },
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "coupons": [],
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "future_renewal_dates": [],
      "id": "WmPnWqPKbpFRmy6Ma2BG",
      "is_active": true,
      "is_cancelled": false,
      "is_occurrence_limit": false,
      "is_overdue": false,
      "is_suspended": false,
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "num_overdue": 0,
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "internal_id": "robo_vac",
        "list_price": 149.99,
        "name": "Robo Vac",
        "price": 149.99,
        "quantity": 1,
        "sku": "robo_vac_sku"
      },
      "product_sales": [
        "zGld6plAkacWRzRwblaJ"
      ],
      "products_detailed": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "price": 89.99,
          "quantity": 1,
          "name": "USB HDD",
          "description": "Great USB for data storage.",
          "total_amount": 89.99,
          "discount_amount": 3.75,
          "is_subscription": false,
          "is_trial": false,
          "internal_id": "usb_hdd",
          "sku": "usb_hdd_sku",
          "url": "https://mystore.com/usb-hdd",
          "images": [
            {
              "id": "2r14zlG0mjF5zbQ24XAl",
              "featured": true,
              "file_name": "2r14zlG0mjF5zbQ24XAl",
              "file_ext": "jpg",
              "image_width": 612,
              "image_height": 612,
              "mimetype": "image/jpeg",
              "base_url": "https://productimg.revcent.com",
              "full_url": "https://productimg.revcent.com/2r14zlG0mjF5zbQ24XAl.jpg",
              "compressed_extensions": [
                "_resize_150",
                "_resize_600",
                "_resize_300"
              ]
            }
          ]
        }
      ],
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Active",
      "subscription_profile": {
        "id": "LYE26aKJpPi5VbJmlp2A",
        "name": "Monthly",
        "description": "",
        "occurrences": "specific",
        "occurrences_value": 3,
        "subscription_specific": false,
        "subscription_id": null,
        "frequency_unit": {
          "unit_value": 1,
          "unit": "months"
        },
        "frequency_calendar": {},
        "frequency_fiscal": {},
        "frequency": "unit"
      },
      "subscription_renewals": [],
      "subscription_start_date_unix": 1565814909,
      "tax": [
        "P65Gn2J15pc5KRdLp22w"
      ],
      "transactions": [
        "wLz5MAWPzoUW5VNlydoa"
      ],
      "trial": {
        "id": "LY5yop5nk7hb6o2Pvl5j",
        "start_date": "2019-08-14T20:35:01+00:00",
        "end_date": "2019-08-16T20:35:01+00:00",
        "start_date_unix": 1565814901,
        "end_date_unix": 1565987701,
        "active": false
      },
      "trials": [
        "LY5yop5nk7hb6o2Pvl5j"
      ],
      "updated_date_unix": 1565814910
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="subscription-renewal" data-ordernum="139"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-renewal"><h2>Subscription Renewal</h2><hr></hr><p>A subscription renewal is created when a renewal transaction occurs on a subscription, whether the transaction succeeds or fails. A failed renewal is considered overdue, however the subscription associated with it will continue to be processed. Partial or full declines on a subscription renewal will create a salvage transaction.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="subscription-renewal-refund" data-ordernum="140"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-renewal-refund"><h3>Subscription Renewal Refund</h3><hr></hr><p>Refund a subscription renewal for a specific amount or the full amount.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount to refund. If not provided the entire item amount will be refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewal_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription renewal.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each pending refund created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription renewal.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="subscription-renewal-refund-request" class="highlight-code language-json ">{
  "request": {
    "type": "subscription_renewal",
    "method": "refund",
    "amount": 2.25,
    "subscription_renewal_id": "YaVqjA1JowiGpyEN0o55"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="subscription-renewal-refund-response" class="highlight-code language-json ">{
  "amount": 2.25,
  "api_call_id": "y27kOyLkJNCW6NvnRZRd",
  "api_call_processed": true,
  "api_call_unix": 1565814914,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "pending_refund": [
    "vEwWrAabXRtMMgn0N7bw"
  ],
  "request_method": "refund",
  "request_type": "subscription_renewal",
  "result": "SubscriptionRenewal refunded in the amount of $2.25.",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "subscription_renewal_id": "YaVqjA1JowiGpyEN0o55"
}</pre></div></div></div></section><section id="subscription-renewal-retrieve" data-ordernum="141"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text subscription-renewal-retrieve"><h3>Subscription Renewal Retrieve</h3><hr></hr><p>Retrieve current information on a single subscription renewal or multiple subscription renewals.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any refunds.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_settled<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount settled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_void<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any items that have been voided.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_overdue<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription renewal is overdue. I.e. fully or partially declined.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Payment profile related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">final_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_declined_transactions<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">original_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">step_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_cascade_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_transaction<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products_detailed<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Products detailed is an array of individual product objects, indicating the products which are related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the product</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of the product. I.e. Price * Quantity</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product internal ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product SKU.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">images<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product images if uploaded to RevCent.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_profile<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Details on the subscription profile associated with the subscription.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the number of renewals allowed is specific or indefinite.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">occurrences_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>If occurrences = specific, then the number of occurrence allowed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_specific<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the subscription profile is specific to a single subscription. I.e. customized.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the subscription profile is specific to a single subscription, the subscription ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency setting. Either unit, calendar or fiscal.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_unit<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unit based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">unit_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit value.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The frequency unit, i.e. days, weeks, months or years.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_calendar<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar unit, i.e. The 2nd X of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar value, i.e. The X day of every month.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">calendar_parent<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The calendar parent, i.e. The 2nd day of every X</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">frequency_fiscal<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal based frequency settings for the subscription profile.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_value<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">fiscal_unit<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="subscription-renewal-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "subscription_renewal",
    "method": "retrieve",
    "id": "YaVqjA1JowiGpyEN0o55"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="subscription-renewal-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "Kn51oqr1MpUyyRbazY8l",
  "api_call_processed": true,
  "api_call_unix": 1565814913,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "subscription_renewal",
  "results": [
    {
      "amount": 149.99,
      "amount_captured": 149.99,
      "amount_fees": 4.35,
      "amount_gross": 149.99,
      "amount_net": 145.64,
      "amount_original_total": 149.99,
      "amount_refunded": 0,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_to_salvage": 0,
      "amount_total": 149.99,
      "amount_void": 0,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1565814911,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "YaVqjA1JowiGpyEN0o55",
      "is_overdue": false,
      "live_mode": false,
      "metadata": [],
      "notes": [],
      "offline_payments": [],
      "payment_profile": {
        "id": "l4QbbPOQZES20A1XvjG8",
        "name": "StripeThenAuthorize",
        "results": {
          "final_amount": 158.99,
          "num_declined_transactions": 0,
          "original_amount": 158.99,
          "payment_profile_id": "l4QbbPOQZES20A1XvjG8",
          "step_array": [
            {
              "step_action": "initial",
              "step_amount": 158.99,
              "step_cascade_result": null,
              "step_gateway": "Stripe",
              "step_gateway_id": "GOJankNpkpsPzw6No1OP",
              "step_modifier": "",
              "step_num": 1,
              "step_result": "Approved",
              "step_setting": "initial",
              "step_source": "gateway",
              "step_transaction": "d9ZoKG0n2pIwBG60Q6aW"
            }
          ],
          "successful_gateway": "Stripe",
          "successful_step_num": 1
        }
      },
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "internal_id": "robo_vac",
        "list_price": 149.99,
        "name": "Robo Vac",
        "price": 149.99,
        "quantity": 1,
        "sku": "robo_vac_sku"
      },
      "product_sales": [
        "zGld6plAkacWRzRwblaJ"
      ],
      "products_detailed": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "price": 89.99,
          "quantity": 1,
          "name": "USB HDD",
          "description": "Great USB for data storage.",
          "total_amount": 89.99,
          "discount_amount": 3.75,
          "is_subscription": false,
          "is_trial": false,
          "internal_id": "usb_hdd",
          "sku": "usb_hdd_sku",
          "url": "https://mystore.com/usb-hdd",
          "images": [
            {
              "id": "2r14zlG0mjF5zbQ24XAl",
              "featured": true,
              "file_name": "2r14zlG0mjF5zbQ24XAl",
              "file_ext": "jpg",
              "image_width": 612,
              "image_height": 612,
              "mimetype": "image/jpeg",
              "base_url": "https://productimg.revcent.com",
              "full_url": "https://productimg.revcent.com/2r14zlG0mjF5zbQ24XAl.jpg",
              "compressed_extensions": [
                "_resize_150",
                "_resize_600",
                "_resize_300"
              ]
            }
          ]
        }
      ],
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Fully Captured",
      "subscription_profile": {
        "id": "LYE26aKJpPi5VbJmlp2A",
        "name": "Monthly",
        "description": "",
        "occurrences": "specific",
        "occurrences_value": 3,
        "subscription_specific": false,
        "subscription_id": null,
        "frequency_unit": {
          "unit_value": 1,
          "unit": "months"
        },
        "frequency_calendar": {},
        "frequency_fiscal": {},
        "frequency": "unit"
      },
      "subscriptions": [
        "WmPnWqPKbpFRmy6Ma2BG"
      ],
      "tax": [
        "y27kOyYEQ8CWWWMQQyvk"
      ],
      "transactions": [
        "d9ZoKG0n2pIwBG60Q6aW"
      ],
      "trials": [],
      "updated_date_unix": 1565814912
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="tax" data-ordernum="142"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text tax"><h2>Tax</h2><hr></hr><p>Tax is created when a tax entry is provided in a request or a tax profile matches the customer zip code. Tax profiles, when created and configured, will automatically calculate and create a tax for the customer payment.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="tax-refund" data-ordernum="143"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text tax-refund"><h3>Tax Refund</h3><hr></hr><p>Refund a tax for a specific amount or the full amount.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount to refund. If not provided the entire tax amount will be refunded.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the tax.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refund<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Array containing IDs of each pending refund created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the tax.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="tax-refund-request" class="highlight-code language-json ">{
  "request": {
    "type": "tax",
    "method": "refund",
    "tax_id": "ALRjyqRE27fjjpmRzBRd",
    "amount": 3.25
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="tax-refund-response" class="highlight-code language-json ">{
  "amount": 3.25,
  "api_call_id": "VPm9MqGbyLiJypWVdLMz",
  "api_call_processed": true,
  "api_call_unix": 1565814905,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "pending_refund": [
    "7rwyEm9qZKu66JqWV6W9"
  ],
  "request_method": "refund",
  "request_type": "tax",
  "result": "Tax refunded in the amount of $3.25.",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "tax_id": "ALRjyqRE27fjjpmRzBRd"
}</pre></div></div></div></section><section id="tax-retrieve" data-ordernum="144"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text tax-retrieve"><h3>Tax Retrieve</h3><hr></hr><p>Retrieve current information on a single tax entry or multiple tax entries.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_refunded<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any refunds.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_settled<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount settled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_void<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of any items that have been voided.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_check_direct<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the item was created using a check_direct payment method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_offline_payment<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the item was created using an offline payment method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate calculated based on tax amount and total related item amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">third_party_shop<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Will contain details if the root item is related to a third party shop.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shop_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The URL of the third party shop.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trials<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing trial IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="tax-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "tax",
    "method": "retrieve",
    "id": "ALRjyqRE27fjjpmRzBRd"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="tax-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "7rwyEm9dddu66g2yvzy4",
  "api_call_processed": true,
  "api_call_unix": 1565814905,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "tax",
  "results": [
    {
      "amount_captured": 9.21,
      "amount_fees": 0.25,
      "amount_gross": 9.21,
      "amount_net": 8.96,
      "amount_original_total": 9.31,
      "amount_refunded": 0.1,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_to_salvage": 0,
      "amount_total": 9.21,
      "amount_void": 0,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "description": "Tax rate calculated using provided tax amount.",
      "discounts": [],
      "id": "ALRjyqRE27fjjpmRzBRd",
      "is_check_direct": false,
      "is_offline_payment": false,
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "name": "User Provided Tax",
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [
        "9rdEMaP59RuYg41zRJwW"
      ],
      "product_sales": [
        "9rdEMadyZ7uYgnbKWwX5",
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "rate": 0.08,
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "shipping": [
        "gYamRbaGZphKn8zJVow1"
      ],
      "smtp_messages": [],
      "status": "Fully Captured with Refund",
      "subscription_renewals": [],
      "subscriptions": [],
      "third_party_shop": null,
      "transactions": [
        "ALRjyqRE27fjMonyKLny"
      ],
      "trials": [],
      "updated_date_unix": 1565814903
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="tracking" data-ordernum="145"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text tracking"><h1>Tracking</h1><hr></hr><p>RevCent tracking integrates multiple tracking channels and sources. AdWords, TrackJs and hosted pages are all unique tracking channels.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="googleadwords" data-ordernum="146"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords"><h2>AdWords</h2><hr></hr><p>Implement your Google AdWords accounts within RevCent to receive detailed insight into your AdWords data in combination with RevCent data.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="googleadwords-campaign" data-ordernum="147"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-campaign"><h3>AdWords Campaign</h3><hr></hr><p>AdWords campaign details.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="googleadwords-campaign-retrieve" data-ordernum="148"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-campaign-retrieve"><h3>AdWords Campaign Retrieve</h3><hr></hr><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_advertising_channel_sub_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_advertising_channel_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_amount<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_desktop_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_mobile_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_tablet_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_trial_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_end_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_cpc_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_is_budget_explicitly_shared<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_label_ids<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_labels<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_maximize_conversion_value_target_roas<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_period<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_serving_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_total_amount<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_tracking_url_template<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_url_custom_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="googleadwords-campaign-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "adwords_campaign",
    "method": "retrieve",
    "id": "7rwyyLkrErF8pGb051z1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="googleadwords-campaign-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "o1j8ZoEYZ5hKBvQA8amZ",
  "api_call_processed": true,
  "api_call_unix": 1566315548,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_type": "adwords_campaign",
  "request_method": "retrieve",
  "results": [
    {
      "id": "d9dgI6RJoj8pKjjdNgkG",
      "enabled": true,
      "google_adwords_latest_date": "2019-08-19T00:00:00+00:00",
      "google_adwords_latest_date_unix": 1566172800,
      "google_adwords_data_date": "2019-08-19T00:00:00+00:00",
      "google_adwords_data_date_unix": 1566172800,
      "google_adwords_customer_id": "1234567890",
      "google_adwords_campaign_id": "1234567890",
      "google_adwords_campaign_group_id": "0",
      "google_adwords_campaign_name": "My Campaign Name",
      "google_adwords_campaign_status": "ENABLED",
      "google_adwords_campaign_trial_type": "BASE",
      "google_adwords_tracking_url_template": null,
      "google_adwords_url_custom_parameters": null,
      "google_adwords_advertising_channel_type": "SEARCH",
      "google_adwords_advertising_channel_sub_type": null,
      "google_adwords_bidding_strategy_id": "0",
      "google_adwords_bidding_strategy_type": "cpc",
      "google_adwords_bidding_strategy_name": null,
      "google_adwords_period": "BudgetPeriod_MonthAsDay",
      "google_adwords_serving_status": "SERVING",
      "google_adwords_total_amount": null,
      "google_adwords_labels": null,
      "google_adwords_label_ids": null,
      "google_adwords_maximize_conversion_value_target_roas": 0,
      "google_adwords_campaign_tablet_bid_modifier": -0.4,
      "google_adwords_campaign_mobile_bid_modifier": -0.4,
      "google_adwords_campaign_desktop_bid_modifier": null,
      "google_adwords_amount": 600000000,
      "google_adwords_enhanced_cpc_enabled": false,
      "google_adwords_is_budget_explicitly_shared": false,
      "google_adwords_end_date": null
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="googleadwords-ad-group" data-ordernum="149"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-ad-group"><h3>AdWords Ad Group</h3><hr></hr><p>AdWords ad group details.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="googleadwords-ad-group-retrieve" data-ordernum="150"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-ad-group-retrieve"><h3>AdWords Ad Group Retrieve</h3><hr></hr><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_campaign<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_desktop_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_mobile_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_tablet_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_rotation_mode<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_content_bid_criterion_type_group<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpc_bid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpm_bid_str<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpv_bid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_effective_targeting_roas<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_effective_targeting_roas_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_cpc_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_label_ids<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_labels<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_target_cpa<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_target_cpa_bid_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_tracking_url_template<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_url_custom_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="googleadwords-ad-group-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "adwords_ad_group",
    "method": "retrieve",
    "id": "7rwyyLkrErF8pGb051z1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="googleadwords-ad-group-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "Nk5XzpALG6FrzXdW9Q01",
  "api_call_processed": true,
  "api_call_unix": 1566316453,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "adwords_ad_group",
  "results": [
    {
      "id": "GO8sAkgqokzwMV6lkOlb",
      "enabled": true,
      "google_adwords_latest_date": "2019-08-19T00:00:00+00:00",
      "google_adwords_latest_date_unix": 1566172800,
      "google_adwords_data_date": "2019-08-19T00:00:00+00:00",
      "google_adwords_data_date_unix": 1566172800,
      "google_adwords_customer_id": "1234567890",
      "google_adwords_campaign_id": "1234567890",
      "google_adwords_ad_group_id": "1234567890",
      "google_adwords_ad_group_name": "My Ad Group Name",
      "google_adwords_ad_group_status": "ENABLED",
      "google_adwords_ad_group_type": "SEARCH_STANDARD",
      "google_adwords_ad_rotation_mode": null,
      "google_adwords_bidding_strategy_name": null,
      "google_adwords_bidding_strategy_id": "0",
      "google_adwords_bidding_strategy_source": "CAMPAIGN",
      "google_adwords_bidding_strategy_type": "cpc",
      "google_adwords_target_cpa": null,
      "google_adwords_target_cpa_bid_source": null,
      "google_adwords_tracking_url_template": null,
      "google_adwords_url_custom_parameters": null,
      "google_adwords_content_bid_criterion_type_group": "None",
      "google_adwords_cpm_bid_str": null,
      "google_adwords_cpc_bid": "1000000",
      "google_adwords_cpv_bid": null,
      "google_adwords_labels": null,
      "google_adwords_label_ids": null,
      "google_adwords_ad_group_mobile_bid_modifier": null,
      "google_adwords_ad_group_desktop_bid_modifier": null,
      "google_adwords_ad_group_tablet_bid_modifier": null,
      "google_adwords_enhanced_cpc_enabled": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="googleadwords-ad" data-ordernum="151"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-ad"><h3>AdWords Ad</h3><hr></hr><p>AdWords ad details.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="googleadwords-ad-retrieve" data-ordernum="152"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-ad-retrieve"><h3>AdWords Ad Retrieve</h3><hr></hr><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_ad_group<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_campaign<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_accent_color<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_allow_flexible_color<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_automated<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_business_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_call_only_phone_number<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_call_to_action_text<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_combined_approval_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_destination_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_final_app_urls<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_final_mobile_urls<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_final_urls<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_tracking_url_template<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_url_custom_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_description_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_description_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_device_preference<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_display_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_display_creative_landscape_logo_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_display_creative_logo_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_display_creative_marketing_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_display_creative_marketing_image_square_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_format_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_creative_header_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_creative_logo_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_creative_marketing_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_teaser_business_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_teaser_description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_teaser_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_headline_part_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_headline_part_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_ad_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_creative_image_height<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_creative_image_width<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_creative_mime_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_creative_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_label_ids<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_labels<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_long_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_main_color<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_marketing_image_call_to_action_text<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_marketing_image_call_to_action_text_color<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_marketing_image_description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_marketing_image_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_path_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_path_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_price_prefix<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_promo_text<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_responsive_search_ad_descriptions<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_responsive_search_ad_headlines<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_responsive_search_ad_path_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_responsive_search_ad_path_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_short_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_system_managed_entity_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="googleadwords-ad-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "adwords_ad",
    "method": "retrieve",
    "id": "7rwyyLkrErF8pGb051z1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="googleadwords-ad-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "7rwdzXAzvlHa5gJ6Wmjq",
  "api_call_processed": true,
  "api_call_unix": 1566316524,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "adwords_ad",
  "results": [
    {
      "id": "JNwXhYBlkaWZ5A5zjoGq",
      "enabled": true,
      "google_adwords_latest_date": "2019-08-19T00:00:00+00:00",
      "google_adwords_latest_date_unix": 1566172800,
      "google_adwords_data_date": "2019-08-19T00:00:00+00:00",
      "google_adwords_data_date_unix": 1566172800,
      "google_adwords_customer_id": "1234567890",
      "google_adwords_ad_group_id": "1234567890",
      "google_adwords_creative_id": "1234567890",
      "google_adwords_campaign_id": "1234567890",
      "google_adwords_ad_type": "EXPANDED_TEXT_AD",
      "google_adwords_combined_approval_status": "approved",
      "google_adwords_display_url": null,
      "google_adwords_long_headline": null,
      "google_adwords_headline": null,
      "google_adwords_short_headline": null,
      "google_adwords_description": "My ad description.",
      "google_adwords_price_prefix": null,
      "google_adwords_promo_text": null,
      "google_adwords_status": "ENABLED",
      "google_adwords_labels": null,
      "google_adwords_label_ids": null,
      "google_adwords_enhanced_display_creative_landscape_logo_image_media_id": null,
      "google_adwords_enhanced_display_creative_logo_image_media_id": null,
      "google_adwords_enhanced_display_creative_marketing_image_media_id": null,
      "google_adwords_enhanced_display_creative_marketing_image_square_media_id": null,
      "google_adwords_gmail_teaser_headline": null,
      "google_adwords_gmail_teaser_description": null,
      "google_adwords_gmail_teaser_business_name": null,
      "google_adwords_gmail_creative_header_image_media_id": null,
      "google_adwords_gmail_creative_logo_image_media_id": null,
      "google_adwords_gmail_creative_marketing_image_media_id": null,
      "google_adwords_marketing_image_call_to_action_text": null,
      "google_adwords_marketing_image_call_to_action_text_color": null,
      "google_adwords_marketing_image_headline": null,
      "google_adwords_marketing_image_description": null,
      "google_adwords_accent_color": null,
      "google_adwords_business_name": null,
      "google_adwords_call_to_action_text": null,
      "google_adwords_call_only_phone_number": null,
      "google_adwords_creative_destination_url": null,
      "google_adwords_creative_final_app_urls": null,
      "google_adwords_creative_final_mobile_urls": null,
      "google_adwords_creative_final_urls": "['myfinalurl.com/']",
      "google_adwords_creative_tracking_url_template": null,
      "google_adwords_creative_url_custom_parameters": null,
      "google_adwords_format_setting": null,
      "google_adwords_image_ad_url": null,
      "google_adwords_image_creative_image_height": null,
      "google_adwords_image_creative_image_width": null,
      "google_adwords_image_creative_mime_type": null,
      "google_adwords_image_creative_name": null,
      "google_adwords_main_color": null,
      "google_adwords_responsive_search_ad_descriptions": null,
      "google_adwords_responsive_search_ad_headlines": null,
      "google_adwords_system_managed_entity_source": null,
      "google_adwords_device_preference": null,
      "google_adwords_allow_flexible_color": null,
      "google_adwords_automated": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="googleadwords-keyword" data-ordernum="153"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-keyword"><h3>AdWords Keyword</h3><hr></hr><p>AdWords keyword details.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="googleadwords-keyword-retrieve" data-ordernum="154"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-keyword-retrieve"><h3>AdWords Keyword Retrieve</h3><hr></hr><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_ad_group<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_campaign<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_approval_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpc_bid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpc_bid_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpm_bid_str<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_quality_score<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_criteria<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_criteria_destination_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_criterion_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_cpc_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_estimated_add_clicks_at_first_position_cpc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_estimated_add_cost_at_first_position_cpc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_first_page_cpc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_first_position_cpc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_has_quality_score<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_is_negative<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_keyword_match_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_label_ids<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_labels<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_post_click_quality_score<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_quality_score<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_search_predicted_ctr<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_system_serving_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_top_of_page_cpc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_tracking_url_template<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_url_custom_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_verticle_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="googleadwords-keyword-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "adwords_keyword",
    "method": "retrieve",
    "id": "7rwyyLkrErF8pGb051z1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="googleadwords-keyword-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "JN5pzYNM26FKQZPdyJ2q",
  "api_call_processed": true,
  "api_call_unix": 1566316599,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "adwords_keyword",
  "results": [
    {
      "id": "GOkQd11UlbGqlb42mYl7",
      "enabled": true,
      "google_adwords_latest_date": "2019-08-19T00:00:00+00:00",
      "google_adwords_latest_date_unix": 1566172800,
      "google_adwords_data_date": "2019-08-19T00:00:00+00:00",
      "google_adwords_data_date_unix": 1566172800,
      "google_adwords_customer_id": "1234567890",
      "google_adwords_ad_group_id": "1234567890",
      "google_adwords_campaign_id": "1234567890",
      "google_adwords_criterion_id": "1234567890",
      "google_adwords_bidding_strategy_id": "0",
      "google_adwords_bidding_strategy_name": null,
      "google_adwords_bidding_strategy_source": "CAMPAIGN",
      "google_adwords_bidding_strategy_type": "cpc",
      "google_adwords_cpc_bid": "2900000",
      "google_adwords_cpc_bid_source": "CRITERION",
      "google_adwords_cpm_bid_str": null,
      "google_adwords_approval_status": "APPROVED",
      "google_adwords_criteria": "+mykeyword",
      "google_adwords_criteria_destination_url": null,
      "google_adwords_quality_score": "5",
      "google_adwords_creative_quality_score": "BELOW_AVERAGE",
      "google_adwords_post_click_quality_score": "ABOVE_AVERAGE",
      "google_adwords_keyword_match_type": "BROAD",
      "google_adwords_status": "ENABLED",
      "google_adwords_system_serving_status": "ELIGIBLE",
      "google_adwords_labels": null,
      "google_adwords_label_ids": null,
      "google_adwords_first_page_cpc": "2100000",
      "google_adwords_first_position_cpc": "4430000",
      "google_adwords_search_predicted_ctr": "BELOW_AVERAGE",
      "google_adwords_top_of_page_cpc": "3630000",
      "google_adwords_tracking_url_template": null,
      "google_adwords_url_custom_parameters": null,
      "google_adwords_estimated_add_clicks_at_first_position_cpc": 58,
      "google_adwords_estimated_add_cost_at_first_position_cpc": 355320000,
      "google_adwords_enhanced_cpc_enabled": false,
      "google_adwords_has_quality_score": true,
      "google_adwords_is_negative": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="googleadwords-click" data-ordernum="155"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-click"><h3>AdWords Click</h3><hr></hr><p>AdWords click details.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="googleadwords-click-retrieve" data-ordernum="156"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-click-retrieve"><h3>AdWords Click Retrieve</h3><hr></hr><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_ad<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_ad_group<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_campaign<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_keyword<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_account_descriptive_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_format<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_network_type1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_network_type2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_city_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_country_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_metro_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_most_specific_target_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_region_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_location_target_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_click_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_click_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_click_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_click_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_clicks<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_criteria_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_device<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_keyword_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_keyword_match_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_city_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_country_criteria_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_metro_criteria_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_most_specific_target_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_region_criteria_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_month_of_year<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_slot<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_user_list_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="googleadwords-click-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "adwords_click",
    "method": "retrieve",
    "id": "7rwyyLkrErF8pGb051z1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="googleadwords-click-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "0pwabKyL1BTXR225op84",
  "api_call_processed": true,
  "api_call_unix": 1566316650,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "adwords_click",
  "results": [
    {
      "id": "6r1oKOiNGvYYLMN4ZWnR",
      "google_adwords_latest_date": "2019-08-20T12:21:35+00:00",
      "google_adwords_latest_date_unix": 1566303695,
      "google_adwords_data_date": "2019-08-20T12:21:35+00:00",
      "google_adwords_data_date_unix": 1566303695,
      "google_adwords_aoi_city_criteria_id": null,
      "google_adwords_aoi_country_criteria_id": null,
      "google_adwords_aoi_metro_criteria_id": null,
      "google_adwords_aoi_most_specific_target_id": null,
      "google_adwords_aoi_region_criteria_id": null,
      "google_adwords_campaign_location_target_id": 1234567890,
      "google_adwords_lop_city_criteria_id": 1234567890,
      "google_adwords_lop_country_criteria_id": 1234567890,
      "google_adwords_lop_metro_criteria_id": 1234567890,
      "google_adwords_lop_most_specific_target_id": 1234567890,
      "google_adwords_lop_region_criteria_id": 1234567890,
      "google_adwords_user_list_id": null,
      "google_adwords_account_descriptive_name": "1234567890",
      "google_adwords_ad_format": "text",
      "google_adwords_ad_network_type1": "Search Network",
      "google_adwords_ad_network_type2": "Google search",
      "google_adwords_click_type": "Headline",
      "google_adwords_clicks": 1,
      "google_adwords_criteria_parameters": "+mykeyword",
      "google_adwords_device": "Mobile devices with full browsers",
      "google_adwords_keyword_match_type": "Broad",
      "google_adwords_month_of_year": "August",
      "google_adwords_page": 1,
      "google_adwords_slot": "Google search: Top",
      "google_adwords_customer_id": "1234567890",
      "google_adwords_ad_id": "1234567890",
      "google_adwords_keyword_id": "1234567890",
      "google_adwords_click_id": "CjwKCAjwtO7q.....",
      "google_adwords_click_date": "2019-08-20T00:00:00.000Z"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="googleadwords-objects-retrieve" data-ordernum="157"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text googleadwords-objects-retrieve"><h2>AdWords Response Objects</h2><hr></hr><p>When a retrieve response has an associated AdWords click ID, the AdWords response objects will be included in the response object(s). If a sale, product sale, tracking visitor, etc. has an AdWords click ID associated with it, RevCent will append each response object with additional details specific to the AdWords click ID.<br><br><strong>Example</strong>: If a sale has an associated AdWords click ID, the sale retrieve response will include the AdWords response objects. If a sale does not have an AdWords click ID, the AdWords response objects will not be included.</p><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_ad<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_combined_approval_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_display_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_long_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_short_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_price_prefix<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_promo_text<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_labels<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_label_ids<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_display_creative_landscape_logo_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_display_creative_logo_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_display_creative_marketing_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_display_creative_marketing_image_square_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_teaser_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_teaser_description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_teaser_business_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_creative_header_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_creative_logo_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_gmail_creative_marketing_image_media_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_marketing_image_call_to_action_text<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_marketing_image_call_to_action_text_color<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_marketing_image_headline<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_marketing_image_description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_accent_color<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_business_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_call_to_action_text<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_call_only_phone_number<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_destination_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_final_app_urls<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_final_mobile_urls<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_final_urls<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_tracking_url_template<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_url_custom_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_format_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_ad_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_creative_image_height<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_creative_image_width<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_creative_mime_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_image_creative_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_main_color<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_responsive_search_ad_descriptions<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_responsive_search_ad_headlines<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_system_managed_entity_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_device_preference<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_allow_flexible_color<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_automated<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_ad_group<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_rotation_mode<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_target_cpa<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_target_cpa_bid_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_tracking_url_template<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_url_custom_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_content_bid_criterion_type_group<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpm_bid_str<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpc_bid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpv_bid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_labels<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_label_ids<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_mobile_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_desktop_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_tablet_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_cpc_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_campaign<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_trial_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_tracking_url_template<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_url_custom_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_advertising_channel_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_advertising_channel_sub_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_period<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_serving_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_total_amount<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_labels<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_label_ids<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_maximize_conversion_value_target_roas<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_tablet_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_mobile_bid_modifier<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_desktop_bid_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_amount<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_cpc_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_is_budget_explicitly_shared<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_end_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_click<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_city_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_country_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_metro_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_most_specific_target_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_aoi_region_criteria_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_location_target_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_city_criteria_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_country_criteria_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_metro_criteria_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_most_specific_target_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_lop_region_criteria_id<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_user_list_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_account_descriptive_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_format<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_network_type1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_network_type2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_click_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_clicks<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_criteria_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_device<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_keyword_match_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_month_of_year<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_slot<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_keyword_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_click_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_click_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">adwords_keyword<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item is enabled or disabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_latest_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_data_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_ad_group_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_criterion_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_bidding_strategy_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpc_bid<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpc_bid_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_cpm_bid_str<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_approval_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_criteria<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_criteria_destination_url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_quality_score<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_creative_quality_score<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_post_click_quality_score<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_keyword_match_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_system_serving_status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_labels<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_label_ids<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_first_page_cpc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_first_position_cpc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_search_predicted_ctr<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_top_of_page_cpc<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_tracking_url_template<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_url_custom_parameters<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_estimated_add_clicks_at_first_position_cpc<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_estimated_add_cost_at_first_position_cpc<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_enhanced_cpc_enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_has_quality_score<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_adwords_is_negative<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first hidden">Request JSON</p><pre id="googleadwords-objects-retrieve-request" class="highlight-code language-json hidden"></pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="googleadwords-objects-retrieve-response" class="highlight-code language-json ">{
  "adwords_ad": {
    "id": "JNwXhYBlkaWZ5A5zjoGq",
    "enabled": true,
    "google_adwords_latest_date": "2019-08-19T00:00:00+00:00",
    "google_adwords_latest_date_unix": 1566172800,
    "google_adwords_data_date": "2019-08-19T00:00:00+00:00",
    "google_adwords_data_date_unix": 1566172800,
    "google_adwords_customer_id": "1234567890",
    "google_adwords_ad_group_id": "1234567890",
    "google_adwords_creative_id": "1234567890",
    "google_adwords_campaign_id": "1234567890",
    "google_adwords_ad_type": "EXPANDED_TEXT_AD",
    "google_adwords_combined_approval_status": "approved",
    "google_adwords_display_url": null,
    "google_adwords_long_headline": null,
    "google_adwords_headline": null,
    "google_adwords_short_headline": null,
    "google_adwords_description": "My ad description.",
    "google_adwords_price_prefix": null,
    "google_adwords_promo_text": null,
    "google_adwords_status": "ENABLED",
    "google_adwords_labels": null,
    "google_adwords_label_ids": null,
    "google_adwords_enhanced_display_creative_landscape_logo_image_media_id": null,
    "google_adwords_enhanced_display_creative_logo_image_media_id": null,
    "google_adwords_enhanced_display_creative_marketing_image_media_id": null,
    "google_adwords_enhanced_display_creative_marketing_image_square_media_id": null,
    "google_adwords_gmail_teaser_headline": null,
    "google_adwords_gmail_teaser_description": null,
    "google_adwords_gmail_teaser_business_name": null,
    "google_adwords_gmail_creative_header_image_media_id": null,
    "google_adwords_gmail_creative_logo_image_media_id": null,
    "google_adwords_gmail_creative_marketing_image_media_id": null,
    "google_adwords_marketing_image_call_to_action_text": null,
    "google_adwords_marketing_image_call_to_action_text_color": null,
    "google_adwords_marketing_image_headline": null,
    "google_adwords_marketing_image_description": null,
    "google_adwords_accent_color": null,
    "google_adwords_business_name": null,
    "google_adwords_call_to_action_text": null,
    "google_adwords_call_only_phone_number": null,
    "google_adwords_creative_destination_url": null,
    "google_adwords_creative_final_app_urls": null,
    "google_adwords_creative_final_mobile_urls": null,
    "google_adwords_creative_final_urls": "['myfinalurl.com/']",
    "google_adwords_creative_tracking_url_template": null,
    "google_adwords_creative_url_custom_parameters": null,
    "google_adwords_format_setting": null,
    "google_adwords_image_ad_url": null,
    "google_adwords_image_creative_image_height": null,
    "google_adwords_image_creative_image_width": null,
    "google_adwords_image_creative_mime_type": null,
    "google_adwords_image_creative_name": null,
    "google_adwords_main_color": null,
    "google_adwords_responsive_search_ad_descriptions": null,
    "google_adwords_responsive_search_ad_headlines": null,
    "google_adwords_system_managed_entity_source": null,
    "google_adwords_device_preference": null,
    "google_adwords_allow_flexible_color": null,
    "google_adwords_automated": false
  },
  "adwords_ad_group": {
    "id": "GO8sAkgqokzwMV6lkOlb",
    "enabled": true,
    "google_adwords_latest_date": "2019-08-19T00:00:00+00:00",
    "google_adwords_latest_date_unix": 1566172800,
    "google_adwords_data_date": "2019-08-19T00:00:00+00:00",
    "google_adwords_data_date_unix": 1566172800,
    "google_adwords_customer_id": "1234567890",
    "google_adwords_campaign_id": "1234567890",
    "google_adwords_ad_group_id": "1234567890",
    "google_adwords_ad_group_name": "My Ad Group Name",
    "google_adwords_ad_group_status": "ENABLED",
    "google_adwords_ad_group_type": "SEARCH_STANDARD",
    "google_adwords_ad_rotation_mode": null,
    "google_adwords_bidding_strategy_name": null,
    "google_adwords_bidding_strategy_id": "0",
    "google_adwords_bidding_strategy_source": "CAMPAIGN",
    "google_adwords_bidding_strategy_type": "cpc",
    "google_adwords_target_cpa": null,
    "google_adwords_target_cpa_bid_source": null,
    "google_adwords_tracking_url_template": null,
    "google_adwords_url_custom_parameters": null,
    "google_adwords_content_bid_criterion_type_group": "None",
    "google_adwords_cpm_bid_str": null,
    "google_adwords_cpc_bid": "1000000",
    "google_adwords_cpv_bid": null,
    "google_adwords_labels": null,
    "google_adwords_label_ids": null,
    "google_adwords_ad_group_mobile_bid_modifier": null,
    "google_adwords_ad_group_desktop_bid_modifier": null,
    "google_adwords_ad_group_tablet_bid_modifier": null,
    "google_adwords_enhanced_cpc_enabled": false
  },
  "adwords_campaign": {
    "id": "d9dgI6RJoj8pKjjdNgkG",
    "enabled": true,
    "google_adwords_latest_date": "2019-08-19T00:00:00+00:00",
    "google_adwords_latest_date_unix": 1566172800,
    "google_adwords_data_date": "2019-08-19T00:00:00+00:00",
    "google_adwords_data_date_unix": 1566172800,
    "google_adwords_customer_id": "1234567890",
    "google_adwords_campaign_id": "1234567890",
    "google_adwords_campaign_group_id": "0",
    "google_adwords_campaign_name": "My Campaign Name",
    "google_adwords_campaign_status": "ENABLED",
    "google_adwords_campaign_trial_type": "BASE",
    "google_adwords_tracking_url_template": null,
    "google_adwords_url_custom_parameters": null,
    "google_adwords_advertising_channel_type": "SEARCH",
    "google_adwords_advertising_channel_sub_type": null,
    "google_adwords_bidding_strategy_id": "0",
    "google_adwords_bidding_strategy_type": "cpc",
    "google_adwords_bidding_strategy_name": null,
    "google_adwords_period": "BudgetPeriod_MonthAsDay",
    "google_adwords_serving_status": "SERVING",
    "google_adwords_total_amount": null,
    "google_adwords_labels": null,
    "google_adwords_label_ids": null,
    "google_adwords_maximize_conversion_value_target_roas": 0,
    "google_adwords_campaign_tablet_bid_modifier": -0.4,
    "google_adwords_campaign_mobile_bid_modifier": -0.4,
    "google_adwords_campaign_desktop_bid_modifier": null,
    "google_adwords_amount": 600000000,
    "google_adwords_enhanced_cpc_enabled": false,
    "google_adwords_is_budget_explicitly_shared": false,
    "google_adwords_end_date": null
  },
  "adwords_click": {
    "id": "6r1oKOiNGvYYLMN4ZWnR",
    "google_adwords_latest_date": "2019-08-20T12:21:35+00:00",
    "google_adwords_latest_date_unix": 1566303695,
    "google_adwords_data_date": "2019-08-20T12:21:35+00:00",
    "google_adwords_data_date_unix": 1566303695,
    "google_adwords_aoi_city_criteria_id": null,
    "google_adwords_aoi_country_criteria_id": null,
    "google_adwords_aoi_metro_criteria_id": null,
    "google_adwords_aoi_most_specific_target_id": null,
    "google_adwords_aoi_region_criteria_id": null,
    "google_adwords_campaign_location_target_id": 1234567890,
    "google_adwords_lop_city_criteria_id": 1234567890,
    "google_adwords_lop_country_criteria_id": 1234567890,
    "google_adwords_lop_metro_criteria_id": 1234567890,
    "google_adwords_lop_most_specific_target_id": 1234567890,
    "google_adwords_lop_region_criteria_id": 1234567890,
    "google_adwords_user_list_id": null,
    "google_adwords_account_descriptive_name": "1234567890",
    "google_adwords_ad_format": "text",
    "google_adwords_ad_network_type1": "Search Network",
    "google_adwords_ad_network_type2": "Google search",
    "google_adwords_click_type": "Headline",
    "google_adwords_clicks": 1,
    "google_adwords_criteria_parameters": "+mykeyword",
    "google_adwords_device": "Mobile devices with full browsers",
    "google_adwords_keyword_match_type": "Broad",
    "google_adwords_month_of_year": "August",
    "google_adwords_page": 1,
    "google_adwords_slot": "Google search: Top",
    "google_adwords_customer_id": "1234567890",
    "google_adwords_ad_id": "1234567890",
    "google_adwords_keyword_id": "1234567890",
    "google_adwords_click_id": "CjwKCAjwtO7q.....",
    "google_adwords_click_date": "2019-08-20T00:00:00.000Z"
  },
  "adwords_customer": {
    "id": "j0d8VC6v7jrR4vnWKAOB",
    "enabled": true,
    "google_adwords_customer_id": "4295558578"
  },
  "adwords_keyword": {
    "id": "GOkQd11UlbGqlb42mYl7",
    "enabled": true,
    "google_adwords_latest_date": "2019-08-19T00:00:00+00:00",
    "google_adwords_latest_date_unix": 1566172800,
    "google_adwords_data_date": "2019-08-19T00:00:00+00:00",
    "google_adwords_data_date_unix": 1566172800,
    "google_adwords_customer_id": "1234567890",
    "google_adwords_ad_group_id": "1234567890",
    "google_adwords_campaign_id": "1234567890",
    "google_adwords_criterion_id": "1234567890",
    "google_adwords_bidding_strategy_id": "0",
    "google_adwords_bidding_strategy_name": null,
    "google_adwords_bidding_strategy_source": "CAMPAIGN",
    "google_adwords_bidding_strategy_type": "cpc",
    "google_adwords_cpc_bid": "2900000",
    "google_adwords_cpc_bid_source": "CRITERION",
    "google_adwords_cpm_bid_str": null,
    "google_adwords_approval_status": "APPROVED",
    "google_adwords_criteria": "+mykeyword",
    "google_adwords_criteria_destination_url": null,
    "google_adwords_quality_score": "5",
    "google_adwords_creative_quality_score": "BELOW_AVERAGE",
    "google_adwords_post_click_quality_score": "ABOVE_AVERAGE",
    "google_adwords_keyword_match_type": "BROAD",
    "google_adwords_status": "ENABLED",
    "google_adwords_system_serving_status": "ELIGIBLE",
    "google_adwords_labels": null,
    "google_adwords_label_ids": null,
    "google_adwords_first_page_cpc": "2100000",
    "google_adwords_first_position_cpc": "4430000",
    "google_adwords_search_predicted_ctr": "BELOW_AVERAGE",
    "google_adwords_top_of_page_cpc": "3630000",
    "google_adwords_tracking_url_template": null,
    "google_adwords_url_custom_parameters": null,
    "google_adwords_estimated_add_clicks_at_first_position_cpc": 58,
    "google_adwords_estimated_add_cost_at_first_position_cpc": 355320000,
    "google_adwords_enhanced_cpc_enabled": false,
    "google_adwords_has_quality_score": true,
    "google_adwords_is_negative": false
  }
}</pre></div></div></div></section><section id="hosted-page" data-ordernum="158"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text hosted-page"><h2>Hosted Page</h2><hr></hr><p>When you receive visits and submissions to your hosted page(s), RevCent records each event as a separate hosted visit or submission. Each event is also tied to tracking visitors and AdWords tracking when applicable.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="hosted-page-visit" data-ordernum="159"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text hosted-page-visit"><h3>Hosted Page Visit</h3><hr></hr><p>Hosted page visit details.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="hosted-page-visit-retrieve" data-ordernum="160"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text hosted-page-visit-retrieve"><h3>Hosted Page Visit Retrieve</h3><hr></hr><p>Retrieve current information on a single hosted page visit or multiple hosted page visits.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_endpoint<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted endpoint related to the item, if the item was created via a hosted page.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">path<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page related to the item, if the item was created via a hosted page.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">path<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page_template<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page template related to the item, if the item was created via a hosted page.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tracking_entry<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tracking_visitor<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent tracking visitor related to the item, if TrackJS was initialized.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="hosted-page-visit-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "hosted_page_visit",
    "method": "retrieve",
    "id": "7rwyyLkrErF8pGb051z1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="hosted-page-visit-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "qZBW960rzVuO2vo7p6XK",
  "api_call_processed": true,
  "api_call_unix": 1566337651,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "hosted_page_visit",
  "results": [
    {
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "Twitter Campaign",
      "created_date_unix": 1566335173,
      "hosted_endpoint": {
        "id": "0pgqKa7nbdTYVn0OaEP8",
        "name": "My Hosted Endpoint",
        "path": "myhostedendpoint"
      },
      "hosted_page": {
        "id": "X8PmOr5mQYfZ0ELpqwBG",
        "name": "myhostedpage",
        "path": "My Hosted Page"
      },
      "hosted_page_template": {
        "id": "pg71R9JJqytKRaqwW6W6",
        "name": "My Page Template"
      },
      "id": "k6vy0dZ7PGTgakp04Rq5",
      "tracking_entry": {
        "id": "RJ5WyOGQR8sW8Ewz697V"
      },
      "tracking_visitor": {
        "id": "pgOa10XqOJuEKKYwwrAj"
      },
      "updated_date_unix": 1566335174
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="hosted-page-submission" data-ordernum="161"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text hosted-page-submission"><h3>Hosted Page Submission</h3><hr></hr><p>Hosted page submission details.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="hosted-page-submission-retrieve" data-ordernum="162"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text hosted-page-submission-retrieve"><h3>Hosted Page Submission Retrieve</h3><hr></hr><p>Retrieve current information on a single hosted page submission or multiple hosted page submissions.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_endpoint<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted endpoint related to the item, if the item was created via a hosted page.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">path<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page related to the item, if the item was created via a hosted page.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">path<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page_template<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page template related to the item, if the item was created via a hosted page.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page_visit<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page visit related to the item, if the item was created via a hosted page.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">submission_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tracking_entry<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tracking_visitor<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent tracking visitor related to the item, if TrackJS was initialized.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="hosted-page-submission-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "hosted_page_submission",
    "method": "retrieve",
    "id": "7rwyyLkrErF8pGb051z1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="hosted-page-submission-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "zGlrJgp4AAI1noBYmqjg",
  "api_call_processed": true,
  "api_call_unix": 1566337734,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_type": "hosted_page_submission",
  "request_method": "retrieve",
  "results": [
    {
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "Twitter Campaign",
      "created_date_unix": 1566335189,
      "hosted_endpoint": {
        "id": "0pgqKa7nbdTYVn0OaEP8",
        "name": "My Hosted Endpoint",
        "path": "myhostedendpoint"
      },
      "hosted_page": {
        "id": "X8PmOr5mQYfZ0ELpqwBG",
        "name": "myhostedpage",
        "path": "My Hosted Page"
      },
      "hosted_page_template": {
        "id": "pg71R9JJqytKRaqwW6W6",
        "name": "My Page Template"
      },
      "hosted_page_visit": {
        "id": "k6vy0dZ7PGTgakp04Rq5"
      },
      "id": "WmPNZYEEX5fR0OBO2WKp",
      "sale": {
        "id": "WmPNZYE2ZKimr5rgp1KZ"
      },
      "submission_type": "sale",
      "tracking_entry": {
        "id": "RJ5WyOGQR8sW8Ewz697V"
      },
      "tracking_visitor": {
        "id": "pgOa10XqOJuEKKYwwrAj"
      },
      "updated_date_unix": 1566335189
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="tracking-visitor" data-ordernum="163"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text tracking-visitor"><h2>Tracking Visitor</h2><hr></hr><p>TrackJS was created by RevCent as an in house tracking solution. When you have successfully set up tracking, each visitor to your website will be assigned an ID and a tracking visitor will be created. Tracking visitors can be tracked across domains, and each visitor can have multiple tracking entries.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="tracking-visitor-retrieve" data-ordernum="164"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text tracking-visitor-retrieve"><h3>Tracking Visitor Retrieve</h3><hr></hr><p>Retrieve current information on a single tracking visitor or multiple tracking visitors.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page related to the initial visit which created the tracking visitor, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">path<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page path.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ip_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The IP address of the tracking visitor, when initially created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tracking_domain<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking domain you created within RevCent.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking domain ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking domain name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">domain<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking domain url.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tracking_entries<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Every tracking visitor receives a tracking entry when navigating to a new page or domain. This allows the tracking across domains, i.e. see when a visitor leaves on website and goes to another.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">initial_visit<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the entry is the initial visit, i.e. when the tracking visitor was initially created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hostname<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking entry hostname.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pathname<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking entry path.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">host<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking entry host.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">referer<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking entry referrer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ip_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The IP address of the tracking visitor when the tracking entry was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tracking_domain<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking domain you created within RevCent.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking domain ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking domain name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">domain<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The tracking domain url.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">hosted_page<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page related to the tracking entry, if applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">path<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent hosted page path.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">user_agent<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The user agent, or browser, of the tracking visitor when initially created.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="tracking-visitor-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "tracking_visitor",
    "method": "retrieve",
    "id": "7rwyyLkrErF8pGb051z1"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="tracking-visitor-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "ZVEkm8Zo2lFANPwdaBvz",
  "api_call_processed": true,
  "api_call_unix": 1566314766,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "tracking_visitor",
  "results": [
    {
      "created_date_unix": 1565885604,
      "hosted_page": null,
      "id": "mJGJv0BS7vAN14lMrPYj",
      "ip_address": "123.456.789.0",
      "metadata": [],
      "sales": [],
      "tracking_domain": {
        "name": "yourwebsite.com",
        "id": "9r4y1ulR9K6XvVkj0qBp",
        "domain": "yourwebsite.com"
      },
      "tracking_entries": [
        {
          "created_date_unix": 1565885604,
          "id": "LY5bYqN6Uyn9zjv5lwy0",
          "initial_visit": true,
          "hostname": "yourwebsite.com",
          "pathname": "/landingpage/",
          "host": "yourwebsite.com",
          "referer": "yourwebsite.com/landingpage",
          "ip_address": "123.456.789.0",
          "tracking_domain": {
            "name": "yourwebsite.com",
            "id": "9r4y1ulR9K6XvVkj0qBp",
            "domain": "yourwebsite.com"
          },
          "hosted_page": null
        }
      ],
      "updated_date_unix": 1566307582,
      "user_agent": "Mozilla/5.0 (iPad; CPU OS 12_1_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section><section id="trial" data-ordernum="165"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text trial"><h2>Trial</h2><hr></hr><p>A trial is created when a product has a trial period associated with it. A trial can have shipping associated with it, along with shipping rules depending on the product.</p></div></div><div class="col-sm-6 api-section-col api-section-code-col no-content"></div></div></section><section id="trial-expire" data-ordernum="166"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text trial-expire"><h3>Trial Expire</h3><hr></hr><p>Expire a trial manually. RevCent automatically expires transactions based on the trial expiration date. Use this method if you wish to immediately expire a trial and charge a customer.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a payment profile for processing the item payment. This value can either be the RevCent payment profile ID or the custom payment profile name you created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The full response from the merchant gateway as a JSON string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_results<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the payment profile used.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">original_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The original amount submitted in the request using the products, their prices and quantities.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">final_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The final amount that was successfully charged after the payment profile was applied, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step in the payment profile that ended in success, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway that successfully processed the transaction, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_declined_transactions<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of declined transactions that occurred when the payment profile was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_transaction_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of IDs for declined transactions during the payment profile processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step_array contains individual objects related to the number of steps taken in the process when implementing the payment profile.<br>We highly recommend you read more about the Payment Profile feature at RevCent to gain a better understanding of what steps are as well as step methods.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">step_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The action taken during the step.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The resulting step amount to be charged after any modifiers to payment amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_cascade_result<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of gateways used when processing the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled_gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateways which were enabled within the cascade for processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The results for each gateway validated within the cascade, after being passed or failed due to in place rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway validated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of the gateway within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all revenue rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were present and enabled, the results of the revenue validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all time rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were present and enabled, the results of the time validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all gateway validation requirements.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway which was selected first for validation.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The response returned by the gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The modifier applied to the payment amount, if any.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific step number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result of the step transaction</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step setting.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step source, either gateway or cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_transaction<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the step transaction.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the product sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction details object, if created as a result of the request. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_creator<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction will create a new sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction_created<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a salvage transaction was created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ship to object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of shipping items created. Each object is an individual shipping item containing details.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_overdue<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_occurrence_limit<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of tax items created. Each object is an individual tax item containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate calculated based on tax amount and total related item amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the credit card transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the trial.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="trial-expire-request" class="highlight-code language-json ">{
  "request": {
    "type": "trial",
    "method": "expire",
    "trial_id": "LY5yop5nk7hb6o2Pvl5j"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="trial-expire-response" class="highlight-code language-json ">{
  "amount": 158.99,
  "amount_captured": 158.99,
  "amount_fees": 4.61,
  "amount_gross": 158.99,
  "amount_net": 154.38,
  "amount_original_total": 158.99,
  "amount_remaining": 0,
  "amount_to_salvage": 0,
  "api_call_id": "rm9EA5P5PVHoL5GpQrjL",
  "api_call_processed": true,
  "api_call_unix": 1565814909,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "card_id": "1rQA58w6XXcMNRApYLPn",
  "code": 1,
  "customer": {
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "cus_9299",
    "first_name": "ahux",
    "last_name": "qtrpinkz",
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "city": "Washington",
    "state": "DC",
    "zip": "20500",
    "company": "",
    "country": "USA",
    "email": "bwbb@gmail.com",
    "phone": "1234567890",
    "metadata": []
  },
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "gateway": "Stripe",
  "gateway_id": "GOJankNpkpsPzw6No1OP",
  "gateway_raw_response": "",
  "payment_profile_results": {
    "payment_profile_id": "l4QbbPOQZES20A1XvjG8",
    "original_amount": 158.99,
    "final_amount": 158.99,
    "successful_step_num": 1,
    "successful_gateway": "Stripe",
    "num_declined_transactions": 0,
    "step_array": [
      {
        "step_action": "initial",
        "step_amount": 158.99,
        "step_cascade_result": null,
        "step_gateway": "Stripe",
        "step_gateway_id": "GOJankNpkpsPzw6No1OP",
        "step_modifier": "",
        "step_num": 1,
        "step_result": "Approved",
        "step_setting": "initial",
        "step_source": "gateway",
        "step_transaction": null
      }
    ]
  },
  "product": {
    "id": "0pBLXVZW08SNw0XOKZ7X",
    "name": "Robo Vac",
    "internal_id": "robo_vac",
    "sku": "robo_vac_sku",
    "price": 149.99,
    "quantity": 1
  },
  "product_sale_id": "zGld6plAkacWRzRwblaJ",
  "request_method": "expire",
  "request_type": "trial",
  "result": "Trial expired and subscription started.",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "salvage_transaction": null,
  "salvage_transaction_created": false,
  "ship_to": null,
  "shipping_created": [],
  "subscription": {
    "id": "WmPnWqPKbpFRmy6Ma2BG",
    "is_overdue": false,
    "is_occurrence_limit": false
  },
  "subscription_id": "WmPnWqPKbpFRmy6Ma2BG",
  "tax_created": [
    {
      "amount_original_total": 9,
      "amount_captured": 9,
      "amount_gross": 9,
      "amount_net": 8.74,
      "amount_fees": 0.26,
      "amount_remaining": 0,
      "amount_to_salvage": 0,
      "id": "P65Gn2J15pc5KRdLp22w",
      "name": "Tax Profile: aeega",
      "description": "",
      "rate": 0.06
    }
  ],
  "transaction_id": "wLz5MAWPzoUW5VNlydoa",
  "trial_id": "LY5yop5nk7hb6o2Pvl5j"
}</pre></div></div></div></section><section id="trial-cancel" data-ordernum="167"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text trial-cancel"><h3>Trial Cancel</h3><hr></hr><p>Cancel a trial. Cancelling a trial will not charge the customer, and any subscription related to the trial will be cancelled as well.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial ID</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The full response from the merchant gateway as a JSON string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_results<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the payment profile used.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">original_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The original amount submitted in the request using the products, their prices and quantities.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">final_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The final amount that was successfully charged after the payment profile was applied, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step in the payment profile that ended in success, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway that successfully processed the transaction, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_declined_transactions<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of declined transactions that occurred when the payment profile was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_transaction_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of IDs for declined transactions during the payment profile processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step_array contains individual objects related to the number of steps taken in the process when implementing the payment profile.<br>We highly recommend you read more about the Payment Profile feature at RevCent to gain a better understanding of what steps are as well as step methods.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">step_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The action taken during the step.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The resulting step amount to be charged after any modifiers to payment amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_cascade_result<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of gateways used when processing the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled_gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateways which were enabled within the cascade for processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The results for each gateway validated within the cascade, after being passed or failed due to in place rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway validated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of the gateway within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all revenue rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were present and enabled, the results of the revenue validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all time rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were present and enabled, the results of the time validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all gateway validation requirements.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway which was selected first for validation.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The response returned by the gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The modifier applied to the payment amount, if any.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific step number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result of the step transaction</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step setting.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step source, either gateway or cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_transaction<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the step transaction.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the product sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction details object, if created as a result of the request. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_creator<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction will create a new sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction_created<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a salvage transaction was created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ship to object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of shipping items created. Each object is an individual shipping item containing details.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_overdue<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_occurrence_limit<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of tax items created. Each object is an individual tax item containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate calculated based on tax amount and total related item amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the credit card transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the trial.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="trial-cancel-request" class="highlight-code language-json ">{
  "request": {
    "type": "trial",
    "method": "cancel",
    "trial_id": "y27kyzRKyoCWWJ82M6pp"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="trial-cancel-response" class="highlight-code language-json ">{
  "amount": 149.99,
  "api_call_id": "wLz5AdRJAoUWV6lj208V",
  "api_call_processed": true,
  "api_call_unix": 1565817264,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "2rdJamrL88fGrBmMYanZ",
  "product_sale_id": "Kn51qY96qjcy5RjjyEER",
  "request_method": "cancel",
  "request_type": "trial",
  "result": "Trial cancelled. Product sale refunded in the amount of $149.99.",
  "sale_id": "zGldprG799CWWwmPGJMX",
  "subscription_cancelled": [
    "ZVEGykm2y6CZJKyvnAqn"
  ],
  "trial_id": "y27kyzRKyoCWWJ82M6pp"
}</pre></div></div></div></section><section id="trial-extend" data-ordernum="168"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text trial-extend"><h3>Trial Extend</h3><hr></hr><p>Extend the duration of the trial by a set number of days.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">days<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of days to extend the trial.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The full response from the merchant gateway as a JSON string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_results<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the payment profile used.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">original_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The original amount submitted in the request using the products, their prices and quantities.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">final_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The final amount that was successfully charged after the payment profile was applied, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step in the payment profile that ended in success, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway that successfully processed the transaction, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_declined_transactions<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of declined transactions that occurred when the payment profile was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_transaction_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of IDs for declined transactions during the payment profile processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step_array contains individual objects related to the number of steps taken in the process when implementing the payment profile.<br>We highly recommend you read more about the Payment Profile feature at RevCent to gain a better understanding of what steps are as well as step methods.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">step_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The action taken during the step.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The resulting step amount to be charged after any modifiers to payment amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_cascade_result<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of gateways used when processing the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled_gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateways which were enabled within the cascade for processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The results for each gateway validated within the cascade, after being passed or failed due to in place rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway validated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of the gateway within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all revenue rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were present and enabled, the results of the revenue validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all time rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were present and enabled, the results of the time validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all gateway validation requirements.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway which was selected first for validation.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The response returned by the gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The modifier applied to the payment amount, if any.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific step number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result of the step transaction</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step setting.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step source, either gateway or cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_transaction<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the step transaction.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the product sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction details object, if created as a result of the request. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_creator<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction will create a new sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction_created<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a salvage transaction was created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ship to object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of shipping items created. Each object is an individual shipping item containing details.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_overdue<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_occurrence_limit<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of tax items created. Each object is an individual tax item containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate calculated based on tax amount and total related item amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the credit card transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the trial.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="trial-extend-request" class="highlight-code language-json ">{
  "request": {
    "type": "trial",
    "method": "extend",
    "trial_id": "LY5yop5nk7hb6o2Pvl5j",
    "days": 4
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="trial-extend-response" class="highlight-code language-json ">{
  "api_call_id": "rm9EA5Lv1LuoXj9mJZWg",
  "api_call_processed": true,
  "api_call_unix": 1565814908,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "days_remaining": 4,
  "end_date_unix": 1566246901,
  "message": "Trial for Robo Vac extended 4 days. Trial ends, and subscription starts on 08/19/2019.",
  "product_sale_id": "zGld6plAkacWRzRwblaJ",
  "request_method": "extend",
  "request_type": "trial",
  "result": "Trial extended 4 days.",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "subscription_id": "WmPnWqPKbpFRmy6Ma2BG",
  "trial_id": "LY5yop5nk7hb6o2Pvl5j"
}</pre></div></div></div></section><section id="trial-shorten" data-ordernum="169"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text trial-shorten"><h3>Trial Shorten</h3><hr></hr><p>Shorten the duration of the trial by a set number of days.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The trial ID</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">days<div class="integer-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of days to shorten the trial.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">card_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer credit card used if a transaction occurred.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Gateway related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_raw_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The full response from the merchant gateway as a JSON string.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_results<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_profile_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the payment profile used.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">original_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The original amount submitted in the request using the products, their prices and quantities.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">final_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The final amount that was successfully charged after the payment profile was applied, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step in the payment profile that ended in success, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">successful_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateway that successfully processed the transaction, if applicable.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">num_declined_transactions<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of declined transactions that occurred when the payment profile was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">declined_transaction_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of IDs for declined transactions during the payment profile processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_array<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step_array contains individual objects related to the number of steps taken in the process when implementing the payment profile.<br>We highly recommend you read more about the Payment Profile feature at RevCent to gain a better understanding of what steps are as well as step methods.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">step_action<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The action taken during the step.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The resulting step amount to be charged after any modifiers to payment amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_cascade_result<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">cascade_order<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of gateways used when processing the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled_gateways<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The gateways which were enabled within the cascade for processing.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>The results for each gateway validated within the cascade, after being passed or failed due to in place rules.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway validated.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">order<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The order of the gateway within the cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">revenue_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Revenue rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all revenue rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If revenue rules were present and enabled, the results of the revenue validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">time_rules<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>Time rules validation result for the gateway.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were enabled for the gateway.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">passed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all time rules.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">details<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>If time rules were present and enabled, the results of the time validation will be displayed here.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the gateway passed all gateway validation requirements.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the gateway which was selected first for validation.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_gateway_response<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The response returned by the gateway used to process the step transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_modifier<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The modifier applied to the payment amount, if any.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_num<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The specific step number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result of the step transaction</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_setting<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step setting.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_source<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The step source, either gateway or cascade.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">step_transaction<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the step transaction.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the product sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">result<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The a brief description of the result of the API call.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the sale.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction details object, if created as a result of the request. Null if not applicable.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The salvage transaction amount.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction is enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sale_creator<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If the salvage transaction will create a new sale.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transaction_created<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>If a salvage transaction was created as a result of the request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">ship_to<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ship to object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of shipping items created. Each object is an individual shipping item containing details.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_overdue<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">is_occurrence_limit<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the subscription.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax_created<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of tax items created. Each object is an individual tax item containing details.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_original_total<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total calculated amount when an item is created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_captured<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The amount captured.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_gross<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current gross amount. Equals (amount_captured + amount_settled).</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_net<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current net amount. Equals (amount_captured + amount_settled) - amount_fees.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_fees<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of calculated fees charged by the payment processor.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_remaining<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">amount_to_salvage<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current amount of related salvage transactions not yet salvaged.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The description of the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">rate<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>Tax rate calculated based on tax amount and total related item amount.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transaction_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the credit card transaction.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">trial_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the trial.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="trial-shorten-request" class="highlight-code language-json ">{
  "request": {
    "type": "trial",
    "method": "shorten",
    "trial_id": "LY5yop5nk7hb6o2Pvl5j",
    "days": 3
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="trial-shorten-response" class="highlight-code language-json ">{
  "api_call_id": "4r158E9E94uVAELbpa2G",
  "api_call_processed": true,
  "api_call_unix": 1565814908,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "days_remaining": 1,
  "end_date_unix": 1565987701,
  "message": "Trial for Robo Vac shortened 3 days. Trial ends, and subscription starts on 08/16/2019.",
  "product_sale_id": "zGld6plAkacWRzRwblaJ",
  "request_method": "shorten",
  "request_type": "trial",
  "result": "Trial shortened 3 days.",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "subscription_id": "WmPnWqPKbpFRmy6Ma2BG",
  "trial_id": "LY5yop5nk7hb6o2Pvl5j"
}</pre></div></div></div></section><section id="trial-retrieve" data-ordernum="170"><div class="row api-section"><div class="col-sm-6 api-section-col"><div class="api-section-text trial-retrieve"><h3>Trial Retrieve</h3><hr></hr><p>Retrieve current information on a single trial or multiple trials.</p><p>Please view <a href="#pagination">Pagination</a> and <a href="#filters">Filters</a> for details on retrieving multiple items.</p><p>The response may include <a href="#googleadwords-objects-retrieve">AdWords Response Objects</a> within each item if an AdWords click ID is associated with the item.</p><h4>Request JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">request<div class="object-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The main request object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">type<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The type of request being made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">method<div class="string-label"></div><div class="required-label"></div></div><div class="col-sm-7 schema-property-value "><p>The method for the request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the item. Required if multiple property equals false or is not present.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">multiple<div class="boolean-label"></div><div class="optional-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether it is a multiple type request.</p></div></div><hr class="card-block-last"></div></div></div><hr class="card-block-last"></div></div></div><h4>Response JSON Schema</h4><div class="card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API call ID of the request. Every API request is assigned an ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_processed<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Indicates whether the API call was processed.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">api_call_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the API call was made.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">code<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The result code for the request.<br>0 = RevCent Error<br>1 = Success</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The number of result items contained in the current page.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">current_page<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current page of result, same as requested page, default is page 1.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_method<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request method.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">request_type<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The API request type.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">results<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array of objects, each object being a unique item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">active<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the trial is currently active.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the campaign.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">campaign_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The name of the campaign associated with the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">check_directs<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing check direct IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">created_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was created.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">customer<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customer object.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_1<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">address_line_2<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' second address line.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">blocked<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer has been blocked from purchases.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">city<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' city.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">company<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' company.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">country<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' country.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">email<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' email.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">enabled<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customer is currently enabled.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">first_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' first name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">full_address<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' full address.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">geocode_success<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the customers' address was successfully geocoded using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">google_place_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The Google place ID for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>Your internal ID for the customer.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">last_name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' last name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lat<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate latitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">lon<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The approximate longitude for the customers' address using the Google geocoding service.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">phone<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' phone number.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">state_long<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' state in long format.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' status.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">zip<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The customers' zip or postal code.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">days_remaining<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>Total amount of days remaining until the trial expires if active.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">days_total<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total duration of the trial in days.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">discounts<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing discounts related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">end_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the trial expires or expired.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">live_mode<div class="boolean-label"></div></div><div class="col-sm-7 schema-property-value "><p>Whether the item was created using a live or test RevCent API key.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">offline_payments<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing offline payment IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">payment_type<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The payment type related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system ID of the payment type related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The system name of the payment type related to the item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">paypal_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing RevCent PayPal transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">pending_refunds<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing pending refund IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product<div class="object-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product object containing information on the related product.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The RevCent ID of the object item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The internal_id you provided when creating the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product sku.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product price for the specific item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product quantity for the specific item.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">product_sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing product sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">products_detailed<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Products detailed is an array of individual product objects, indicating the products which are related to the item.</p></div></div><div class="card sub-card properties-collapse"><div class="card-header centit" role="tab"><a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a></div><div class="collapse" role="tabpanel"><div class="card-block"><hr class="card-block-first"><div class="row"><div class="col-sm-5 schema-property-key text-right">id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The ID of the product</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">price<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The price of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">quantity<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The quantity of the product.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">name<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product name.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">description<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product description.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_amount<div class="float-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total amount of the product. I.e. Price * Quantity</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">internal_id<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product internal ID.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sku<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product SKU.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">url<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The product URL.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">images<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>Product images if uploaded to RevCent.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">sales<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing sale IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">salvage_transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing salvage transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">shipping<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing shipping IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">smtp_messages<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing SMTP message IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">start_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the trial started.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">status<div class="string-label"></div></div><div class="col-sm-7 schema-property-value "><p>The current status of the related item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscription_renewals<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription renewal IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">subscriptions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing subscription IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">tax<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing tax IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">transactions<div class="array-label"></div></div><div class="col-sm-7 schema-property-value "><p>An array containing credit card transaction IDs related to the item.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">updated_date_unix<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The unix timestamp of when the item was updated.</p></div></div><hr class="card-block-last"></div></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_count<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of result items for the given request.</p></div></div><hr><div class="row"><div class="col-sm-5 schema-property-key text-right">total_pages<div class="integer-label"></div></div><div class="col-sm-7 schema-property-value "><p>The total number of pages for the given request.</p></div></div><hr class="card-block-last"></div></div></div></div></div><div class="col-sm-6 api-section-col api-section-code-col"><div class="api-section-code"><p class="col-code-p col-code-first ">Request JSON</p><pre id="trial-retrieve-request" class="highlight-code language-json ">{
  "request": {
    "type": "trial",
    "method": "retrieve",
    "id": "LY5yop5nk7hb6o2Pvl5j"
  }
}</pre><p class="col-code-p col-code-additional  ">Response JSON</p><pre id="trial-retrieve-response" class="highlight-code language-json ">{
  "api_call_id": "YaVqjAznZzuGYgJNZl4K",
  "api_call_processed": true,
  "api_call_unix": 1565814907,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "trial",
  "results": [
    {
      "active": true,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "days_remaining": 1,
      "days_total": 1,
      "discounts": [],
      "end_date_unix": 1565901301,
      "id": "LY5yop5nk7hb6o2Pvl5j",
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "product_id": "0pBLXVZW08SNw0XOKZ7X",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku",
        "name": "Robo Vac",
        "quantity": 1,
        "price": 149.99,
        "list_price": 149.99
      },
      "product_sales": [
        "zGld6plAkacWRzRwblaJ"
      ],
      "products_detailed": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "price": 89.99,
          "quantity": 1,
          "name": "USB HDD",
          "description": "Great USB for data storage.",
          "total_amount": 89.99,
          "discount_amount": 3.75,
          "is_subscription": false,
          "is_trial": false,
          "internal_id": "usb_hdd",
          "sku": "usb_hdd_sku",
          "url": "https://mystore.com/usb-hdd",
          "images": [
            {
              "id": "2r14zlG0mjF5zbQ24XAl",
              "featured": true,
              "file_name": "2r14zlG0mjF5zbQ24XAl",
              "file_ext": "jpg",
              "image_width": 612,
              "image_height": 612,
              "mimetype": "image/jpeg",
              "base_url": "https://productimg.revcent.com",
              "full_url": "https://productimg.revcent.com/2r14zlG0mjF5zbQ24XAl.jpg",
              "compressed_extensions": [
                "_resize_150",
                "_resize_600",
                "_resize_300"
              ]
            }
          ]
        }
      ],
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "start_date_unix": 1565814901,
      "status": "Active",
      "subscription_renewals": [],
      "subscriptions": [
        "WmPnWqPKbpFRmy6Ma2BG"
      ],
      "tax": [],
      "transactions": [],
      "updated_date_unix": 1565814901
    }
  ],
  "total_count": 1,
  "total_pages": 1
}</pre></div></div></div></section>
                </div>


                <section id="query" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query">
                                <h2>Query</h2>
                                <p>Query requests are a multi step process.</p>
                                <p>Step 1: Submit the initial query <a href="#query-request">request</a>.</p>
                                <p>Step 2: The <a href="#query-initial-response">initial response</a> will contain a query_id property.</p>
                                <p>Step 3: Submit a query <a href="#query-retrieve">retrieve</a> using the query_id from step 2 to get the query results.</p>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col no-content">
                        </div>
                    </div>
                </section>

                <section id="query-request" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-request">
                                <h3>Query Request</h3>
                                <p>Every request object should contain a type property, method propery, parameters object and a filters object.</p>
                                <p>The <a href="#query-initial-response">initial response</a> is the same for all query requests, regardless of type.</p>
                                <h4>Request JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        request
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value ">
                                        <p>The main request object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        type
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request type.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        method
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request method.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        parameters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The <a href="#query-parameters">parameters</a> object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        filters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The <a href="#filters">filters</a> object.</p>
                                    </div>
                                </div>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-additional">Request JSON</p>
                                <pre id="query-request-object-request" class="highlight-code language-json">
{
    "request": {
        "type": "sale",
        "method": "query",
        "parameters": {},
        "filters": {}
    }
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="query-initial-response" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query">
                                <h3>Query Initial Response</h3>
                                     <p>Every query request receives a response containing a query_id.</p>
                                     <p>Due to the nature of querying big data, and the unpredictable time it may take, it is necessary to retrieve a submitted query.</p>
                                     <p>Once you have submitted a query request, and an error has not occurred, send a separate query retrieve request to retrieve the official results.</p>
                                     
                                     <h4>Initial Response JSON Schema</h4>
                                     <hr>
                                     <div class="row">
                                         <div class="col-sm-5 schema-property-key text-right">
                                             api_call_id
                                             <div class="string-label"></div>
                                         </div>
                                         <div class="col-sm-7 schema-property-value">
                                             <p>The API call ID of the request. Every API request is assigned an ID.</p>
                                         </div>
                                     </div>
                                     <hr>
                                     <div class="row">
                                         <div class="col-sm-5 schema-property-key text-right">
                                             api_call_processed
                                             <div class="boolean-label"></div>
                                         </div>
                                         <div class="col-sm-7 schema-property-value">
                                             <p>Indicates whether the API call was processed.</p>
                                         </div>
                                     </div>
                                     <hr>
                                     <div class="row">
                                         <div class="col-sm-5 schema-property-key text-right">
                                             code
                                             <div class="integer-label"></div>
                                         </div>
                                         <div class="col-sm-7 schema-property-value">
                                             <p>The result code for the request.</p>
                                             <ul class="list list-unstyled">
                                                 <li>0 = Error</li>
                                                 <li>1 = Successful</li>
                                             </ul>
                                         </div>
                                     </div>
                                     <hr>
                                     <div class="row">
                                         <div class="col-sm-5 schema-property-key text-right">
                                             query_id
                                             <div class="integer-label"></div>
                                         </div>
                                         <div class="col-sm-7 schema-property-value">
                                             <p>The ID to use when submitting a <a href="#query-retrieve">query retrieve</a> request.</p>
                                         </div>
                                     </div>
                                                                 </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-additional">Initial Response JSON</p>
                                <pre id="query-all-response" class="highlight-code language-json">
{
    "api_call_id": "4rG0OJYQnairJa4Z571Y",
    "api_call_processed": true,
    "code": 1,
    "query_id": "Bv0drQZNAYCZRKKwmWml"
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="query-retrieve" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-retrieve">
                                <h3>
                                    Query Retrieve</h3>
                                <p>Retrieve the results of a previously submitted query request using the RevCent query_id from the <a href="#query-initial-response">initial response</a>.</p>
                                <p>The responses containing results for each specific query type are contained in their respective query section below.</p>
                                <h4>Request JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        request
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value ">
                                        <p>The main request object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        type
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request type.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        method
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request method.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        id
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The RevCent ID of the query.</p>
                                    </div>
                                </div>


                                <h4>Response JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_id
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The API call ID of the request. Every API request is assigned an ID.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_processed
                                        <div class="boolean-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>Indicates whether the API call was processed.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        code
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The result code for the request.</p>
                                        <ul class="list list-unstyled">
                                            <li>0 = Error</li>
                                            <li>1 = Successful</li>
                                        </ul>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        count
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The total number of query results returned.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        results
                                        <div class="array-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>An array of objects, each object being a query result.</p>
                                        <p>View the individual query types <a href="#query-metric">metric</a>, <a href="#query-pie">pie</a> and <a href="#query-timeline">timeline</a> for details on their respective result objects.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        status
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The status of the query.</p>
                                        <p>
                                            <strong>Possible Values</strong>
                                        </p>
                                        <dl class="dl-horizontal">
                                            <dt>DONE</dt>
                                            <dd>Query is finished. Results of the query are contained in the results array.</dd>
                                            <dt>RUNNING</dt>
                                            <dd>Query is still running. Submit the retrieve request again.</dd>
                                            <dt>ERROR</dt>
                                            <dd>Query returned an error.</dd>
                                        </dl>
                                    </div>
                                </div>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Request JSON</p>
                                <pre id="query-retrieve-request" class="highlight-code language-json">
{
    "request": {
        "type": "query",
        "method": "retrieve",
        "id": "Bv0drQZNAYCZRKKwmWml"
    }
}</pre>
                                <p class="col-code-p col-code-additional">Response JSON</p>
                                <pre id="query-retrieve-response" class="highlight-code language-json">
{
    "api_call_id": "4rG0OJYQnairJa4Z571Y",
    "api_call_processed": true,
    "code": 1,
    "count": 1,
    "results": [],
    "status": "DONE"
}</pre>
                            </div>
                        </div>
                    </div>
                </section>


                <section id="query-parameters" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-parameters">
                                <h3>Query Parameters</h3>
                                <p>The parameters object contains up to three properties. Type, analytic and group_by.</p>
                                <h4>Parameters Object JSON Schema</h4>

                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        type
                                        <div class="object-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The type of query specified by a name and value.</p>
                                        <p>View details on the <a href="#query-type">type</a> object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        analytic
                                        <div class="array-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The computation being performed based on the object(s) contained in the array.</p>
                                        <p>View details on the <a href="#query-analytic">analytic</a> array.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        group_by
                                        <div class="object-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                            <p>Group query results by a specific field. Note: The group by object for certain query types are either required, optional or ignored.</p>
                                            <p>
                                                <strong>Query Types and Group By</strong>
                                            </p>
                                            <dl class="dl-horizontal">
                                                <dt>metric</dt>
                                                <dd>Ignored.</dd>
                                                <dt>pie</dt>
                                                <dd>Required.</dd>
                                                <dt>timeline</dt>
                                                <dd>Optional.</dd>
                                            </dl>
                                            <p>View details on the <a href="#query-group-by">group by</a> object.</p>
                                    </div>
                                </div>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-additional">Parameters JSON</p>
                                <pre id="query-parameters-object-request" class="highlight-code language-json">
{
    "parameters": {
      "type": {
        "name": "pie",
        "value": ""
      },
      "analytic": [{
        "name": "amount_gross",
        "value": "sum"
      }],
      "group_by": {
        "name": "product",
        "value": "name"
      }
    }
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="query-type" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-type">
                                <h3>Type Parameter</h3>

                                <p>The type parameter is an object. The type object specifies the query type, and for timeline queries it also specifies the date interval.</p>

                                <dl class="dl-horizontal">
                                    <dt>Metric</dt>
                                    <dd>Metric queries do not have a group by parameter. They return basic metrics. Note: Up to 5 analytic objects can be contained
                                        in a metric type query.</dd>
                                    <dd> Example below shows a metric type query. The 'value' property can be left blank.
                                        <pre>"type": {"name": "metric", "value": ""}</pre>
                                    </dd>
                                    <dt>Pie</dt>
                                    <dd>Pie queries return grouped results based on a required group by object. Note: Only one analytic object can be contained
                                        in a pie type query.</dd>
                                    <dd> Example below shows a pie type query. The 'value' property can be left blank.
                                        <pre>"type": {"name": "pie", "value": ""}</pre>
                                    </dd>
                                    <dt>Timeline</dt>
                                    <dd>Timeline queries return grouped results based on a specified date interval. The date interval is specified in type 'value'
                                        property.</dd>
                                    <dd>Up to 5 analytic objects can be contained in a timeline type query when not specifying a group by object.</dd>
                                    <dd>Only one analytic object can be contained in a timeline type query when specifying a group by object.</dd>
                                    <dd> Example below shows a timeline type query. The 'value' property equals "day" which will group results by the created date of the request
                                        type items.
                                        <pre>"type": {"name": "timeline", "value": "day"}</pre>
                                        <p>
                                                <strong>Timeline Value</strong>
                                            </p>
                                            <dl class="dl-horizontal">
                                                <dt>day</dt>
                                                <dd>Daily interval, format: "MM/DD/YY". Example: "03/14/2018".</dd>
                                                <dt>week</dt>
                                                <dd>Week interval, the week number in a given year, format: "ww". Example: "30".</dd>
                                                <dt>month</dt>
                                                <dd>Monthly interval, format: "MMMM". Example: "January".</dd>
                                                <dt>year</dt>
                                                <dd>Yearly interval, format: "YYYY". Example: "2018"</dd>
                                            </dl>
                                    </dd>
                                    
                                </dl>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col no-content">
                        </div>
                    </div>
                </section>

                <section id="query-analytic" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-analytic">
                                <h3>Analytic Parameter</h3>
                                <p>The analytic parameter is an array, unlike type and group_by which are both objects.</p>
                                <p>Up to 5 analytic objects can be contained in a metric type query, only one analytic object in a pie query, and up to 5 analytic objects in a timeline query if not grouping.</p>
                                <p>
                                    <strong>Value Property</strong>
                                </p>
                                <p>The 'value' property can be only one of the three values listed below.</p>

                                <dl class="dl-horizontal">
                                    <dt>sum</dt>
                                    <dd>The sum of the name property. Example below shows an analytic object that will return the sum amount gross.
                                        <pre>"analytic": [{"name": "amount_gross", "value": "sum"}]</pre>
                                    </dd>
                                    <dt>avg</dt>
                                    <dd>The average of the name property. Example below shows an analytic object that will return the average amount gross.
                                        <pre>"analytic": [{"name": "amount_gross", "value": "avg"}]</pre>
                                    </dd>
                                    <dt>count</dt>
                                    <dd>The count of number of distinct items. When using count, the 'name' property will always be equal to the query request type. Example
                                        below shows an analytic object that will return the number of distinct (unique) sales, sale being the query request type.
                                        <pre>"analytic": [{"name": "sale", "value": "count"}]</pre>
                                    </dd>
                                </dl>
                                <p>
                                    <strong>Name Property</strong>
                                </p>
                                <p>The analytic object property 'name' depends on the request type (i.e. sale, product_sale). Allowed 'name' values are listed
                                    below by query request type.</p>

                                <h4>Sale</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be captured.</p>
                                                    <p>Amounts yet to be captured due to a trial or salvage transaction.
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of related salvage transactions.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current total amount after any refunds, additions or other changes.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Product Sale</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be captured.</p>
                                                    <p>Amounts yet to be captured due to a trial or salvage transaction.
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of related salvage transactions.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current total amount after any refunds, additions or other changes.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    price
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The price of the product when the product sale was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    list_price
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The list price of the product when the product sale was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    quantity
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The quantity of the product when the product sale was created.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Shipping</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be captured.</p>
                                                    <p>Amounts yet to be captured due to a trial or salvage transaction.
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of related salvage transactions.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current total amount after any refunds, additions or other changes.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Tax</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be captured.</p>
                                                    <p>Amounts yet to be captured due to a trial or salvage transaction.
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of related salvage transactions.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current total amount after any refunds, additions or other changes.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Transaction</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The amount of the transaction when submitted.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Salvage Transaction</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount to salvage.</p>
                                                    <p>Equals (amount_original_total - amount_charged).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    salvage_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be salvaged.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_charged
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The amount successfully charged in the originating transaction</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The salvaged captured amount, if salvage was attempted and successful.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway if salvage was attempted and successful.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The salvaged gross amount, if salvage was attempted and successful.</p>
                                                    <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The salvaged net amount, if salvage was attempted and successful.</p>
                                                    <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The amount attempted in the originating transaction.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The salvaged refunded amount, if salvage was attempted and successful.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The salvaged settled amount, if salvage was attempted and successful.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Customer</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be captured.</p>
                                                    <p>Amounts yet to be captured due to a trial or salvage transaction.
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of related salvage transactions.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current total amount after any refunds, additions or other changes.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Subscription</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    future_volume
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The future amount to be charged based on currently active subscriptions, occurrences and expiring trials.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    total_volume
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total volume (amount_total + future_volume).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be captured.</p>
                                                    <p>Amounts yet to be captured due to a trial or salvage transaction.
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of related salvage transactions.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current total amount after any refunds, additions or other changes.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Subscription Renewal</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled).</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be captured.</p>
                                                    <p>Amounts yet to be captured due to a trial or salvage transaction.
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of related salvage transactions.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current total amount after any refunds, additions or other changes.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Trial</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_captured
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount captured, if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_fees
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of calculated fees charged by the gateway, if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_gross
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current gross amount.
                                                        <p>Equals (amount_captured + amount_settled), if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_net
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current net amount.
                                                        <p>Equals (amount_captured + amount_settled) - amount_fees, if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_original_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The total calculated amount when the item was created, if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_refunded
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>Total amount of any refunds, if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_remaining
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount remaining to be captured.</p>
                                                    <p>Amounts yet to be captured due to a trial or salvage transaction, if trial has expired.
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_settled
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount settled, if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_to_salvage
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current amount of related salvage transactions, if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    amount_total
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The current total amount after any refunds, additions or other changes, if trial has expired.</p>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col no-content">
                        </div>
                    </div>
                </section>


                <section id="query-group-by" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-group-by">
                                <h3>Group By Parameter</h3>

                                <p>The group_by parameter is an object. Only pie and timeline queries accept a group_by object.</p>
                                <p>The object properties 'name' and 'value' both depend on the request type (i.e. sale, product_sale). The 'value' property
                                    also depends on the 'name' property. The group by list shows allowed group by name and their respective value(s).</p>
                                <p>Example below shows grouping query results by the name of the gateway.</p>
                                <pre>"group_by": {"name": "gateway", "value": "name"}</pre>
                                <h4>Sale</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All sales that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by product name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    revenue_source
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by revenue source. Revenue sources: Product Sale, Shipping and Tax.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Product Sale</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All product sales that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by product name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Shipping</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All shipping items that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shipping_provider
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by shipping provider.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shipping_status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by the shipping status (i.e. delivered, shipped, etc.).</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Tax</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All tax items that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Transaction</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All transactions that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    method
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by transaction method.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by product name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    result
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by transaction result.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    subscription_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by subscription profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Salvage Transaction</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All salvage transactions that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    method
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by transaction method.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by product name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    subscription_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by subscription profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Customer</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All customers that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by product name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    revenue_source
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by revenue source. Revenue sources: Product Sale, Shipping, Tax and Subscription Renewal.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Subscription</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All subscriptions that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by product name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    subscription_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by subscription profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    value_type
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Value type is either past revenue or future revenue.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Subscription Renewal</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All subscription renewals that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by payment profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by product name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    subscription_profile
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by subscription profile name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Trial</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by campaign name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by gateway name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    location
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>latlon</dt>
                                                        <dd>Grouping by customer geo coordinates.</dd>
                                                        <dt>city</dt>
                                                        <dd>Grouping by customer city.</dd>
                                                        <dt>county</dt>
                                                        <dd>Grouping by customer county (US only).</dd>
                                                        <dt>state</dt>
                                                        <dd>Grouping by customer state.</dd>
                                                        <dt>zip</dt>
                                                        <dd>Grouping by customer zip (postal code).</dd>
                                                        <dt>country</dt>
                                                        <dd>Grouping by customer country.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>(variable)</dt>
                                                        <dd>Grouping by all matching metadata values where metadata name is the variable.</dd>
                                                        <p>Example below will group by the values where metadata name submitted was 'adwords_campaign'.</p>
                                                        <pre>"group_by": {"name": "metadata", "value": "adwords_campaign"}</pre>
                                                        <p>All trials that have a metadata entry of {"name":"adwords_campaign", "value": "abc123"} will be grouped by 'abc123'.</p>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by product name.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <dl class="dl-horizontal">
                                                        <dt>name</dt>
                                                        <dd>Grouping by status.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col no-content">
                        </div>
                    </div>
                </section>

                <section id="query-examples" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-examples">
                                <h2>Query Examples</h2>
                                <p>Below are examples query requests and results.</p>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col no-content">
                        </div>
                    </div>
                </section>

                <section id="query-metric" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-metric">
                                <h3>
                                    Metric Query</h3>
                                <p>Query analytic values without grouping.</p>
                                <h4>Request JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        request
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value ">
                                        <p>The main request object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        type
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request type.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        method
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request method.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        parameters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The
                                            <a href="#query-parameters">parameters</a> object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        filters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The
                                            <a href="#filters">filters</a> object.</p>
                                    </div>
                                </div>
                                <div class="api-text-divider"></div>

                                <h4>Retrieve Response JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_id
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The API call ID of the request. Every API request is assigned an ID.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_processed
                                        <div class="boolean-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>Indicates whether the API call was processed.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        code
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The result code for the request.</p>
                                        <ul class="list list-unstyled">
                                            <li>0 = Error</li>
                                            <li>1 = Successful</li>
                                        </ul>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        count
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The total number of results returned.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        results
                                        <div class="array-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>An array of objects, each object being a query result. Fields below are contained in the query result
                                            object(s).</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        (variable property name)
                                        <div class="float-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The combined snake case [analytic_value]_[analytic_name] value for each item in the request analytic array.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        status
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The status of the query.</p>
                                        <p>
                                            <strong>Possible Values</strong>
                                        </p>
                                        <dl class="dl-horizontal">
                                            <dt>DONE</dt>
                                            <dd>Query is finished. Results of the query are contained in the results array.</dd>
                                            <dt>RUNNING</dt>
                                            <dd>Query is still running. Submit the retrieve request again.</dd>
                                            <dt>ERROR</dt>
                                            <dd>Query returned an error.</dd>
                                        </dl>
                                    </div>
                                </div>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Request JSON</p>
                                <pre id="query-metric-request" class="highlight-code language-json">
{
    "request": {
      "type": "sale",
      "method": "query",
      "parameters": {
        "type": {
          "name": "metric",
          "value": ""
        },
        "analytic": [{
          "name": "amount_gross",
          "value": "sum"
        }, {
          "name": "amount_fees",
          "value": "sum"
        }]
      },
      "filters": {
        "date_start": "2018-05-17T18:46:14.646Z",
        "date_end": "2018-07-30T18:46:14.647Z",
        "campaign_filter": ["JNXLPjkA1jI2PEK0lNqP"],
        "metadata_filter": [{
          "value": "campaign_abc123",
          "name": "adwords_campaign"
        }]
      }
    }
}</pre>
                                <p class="col-code-p col-code-additional">Retrieve Response JSON</p>
                                <pre id="query-metric-response" class="highlight-code language-json">
{
    "api_call_id": "4rG0OJYQnairJa4Z571Y",
    "api_call_processed": true,
    "code": 1,
    "count": 1,
    "results": [{
      "sum_amount_gross": 9624.5,
      "sum_amount_fees": 246.71
    }],
    "status": "DONE"
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="query-pie" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-pie">
                                <h3>
                                    Pie Query</h3>
                                <p>Query based on grouped items.</p>
                                <h4>Request JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        request
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value ">
                                        <p>The main request object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        type
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request type.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        method
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request method.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        parameters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The
                                            <a href="#query-parameters">parameters</a> object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        filters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The
                                            <a href="#filters">filters</a> object.</p>
                                    </div>
                                </div>
                                <div class="api-text-divider"></div>

                                <h4>Retrieve Response JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_id
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The API call ID of the request. Every API request is assigned an ID.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_processed
                                        <div class="boolean-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>Indicates whether the API call was processed.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        code
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The result code for the request.</p>
                                        <ul class="list list-unstyled">
                                            <li>0 = Error</li>
                                            <li>1 = Successful</li>
                                        </ul>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        count
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The total number of results returned.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        results
                                        <div class="array-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>An array of objects, each object being a query result. Fields below are contained in the query result object(s).</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        group_by_value
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The grouped value specified in the request group_by name and value.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        (variable property name)
                                        <div class="float-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The combined snake case [analytic_value]_[analytic_name] value for each item in the request analytic array.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        status
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The status of the query.</p>
                                        <p>
                                            <strong>Possible Values</strong>
                                        </p>
                                        <dl class="dl-horizontal">
                                            <dt>DONE</dt>
                                            <dd>Query is finished. Results of the query are contained in the results array.</dd>
                                            <dt>RUNNING</dt>
                                            <dd>Query is still running. Submit the retrieve request again.</dd>
                                            <dt>ERROR</dt>
                                            <dd>Query returned an error.</dd>
                                        </dl>
                                    </div>
                                </div>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Request JSON</p>
                                <pre id="query-pie-request" class="highlight-code language-json">
{
    "request": {
      "type": "sale",
      "method": "query",
      "parameters": {
        "type": {
          "name": "pie",
          "value": ""
        },
        "analytic": [{
          "name": "amount_gross",
          "value": "sum"
        }],
        "group_by": {
          "name": "product",
          "value": "name"
        }
      },
      "filters": {
        "date_start": "2018-06-17T18:46:14.646Z",
        "date_end": "2018-07-23T18:46:14.647Z",
        "campaign_filter": ["JNXLPjkA1jI2PEK0lNqP"],
        "metadata_filter": [{
          "value": "campaign_abc123",
          "name": "adwords_campaign"
        }]
      }
    }
}</pre>
                                <p class="col-code-p col-code-additional">Retrieve Response JSON</p>
                                <pre id="query-pie-response" class="highlight-code language-json">
{
    "api_call_id": "4rG0OJYQnairJa4Z571Y",
    "api_call_processed": true,
    "code": 1,
    "count": 2,
    "results": [{
      "group_by_value": "Robo Vac",
      "sum_amount_gross": 2320.97
    }, {
      "group_by_value": "ID Protect",
      "sum_amount_gross": 189.81
    }],
    "status": "DONE"
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="query-timeline" class="docs-query-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text query-timeline">
                                <h3>
                                    Timeline Query</h3>
                                <p>Query grouped or ungrouped analytic during a specified timeline.</p>
                                <h4>Request JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        request
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value ">
                                        <p>The main request object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        type
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request type.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        method
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request method.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        parameters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The <a href="#query-parameters">parameters</a> object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        filters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The <a href="#filters">filters</a> object.</p>
                                    </div>
                                </div>
                                <div class="api-text-divider"></div>

                                <h4>Retrieve Response JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_id
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The API call ID of the request. Every API request is assigned an ID.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_processed
                                        <div class="boolean-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>Indicates whether the API call was processed.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        code
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The result code for the request.</p>
                                        <ul class="list list-unstyled">
                                            <li>0 = Error</li>
                                            <li>1 = Successful</li>
                                        </ul>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        count
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The total number of results returned.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        results
                                        <div class="array-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>An array of objects, each object being a query result. Fields below are contained in the query result object(s).</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        type_value
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The date interval specified in the request type.value .</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        group_by_value
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The grouped value specified in the request group_by name and value.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        (variable property name)
                                        <div class="float-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The combined snake case [analytic_value]_[analytic_name] value for each item in the request analytic array.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        status
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The status of the query.</p>
                                        <p>
                                            <strong>Possible Values</strong>
                                        </p>
                                        <dl class="dl-horizontal">
                                            <dt>DONE</dt>
                                            <dd>Query is finished. Results of the query are contained in the results array.</dd>
                                            <dt>RUNNING</dt>
                                            <dd>Query is still running. Submit the retrieve request again.</dd>
                                            <dt>ERROR</dt>
                                            <dd>Query returned an error.</dd>
                                        </dl>
                                    </div>
                                </div>                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Request JSON</p>
                                <pre id="query-timeline-request" class="highlight-code language-json">
{
    "request": {
      "type": "sale",
      "method": "query",
      "parameters": {
        "type": {
          "name": "timeline",
          "value": "day"
        },
        "analytic": [{
          "name": "amount_gross",
          "value": "sum"
        }],
        "group_by": {
          "name": "gateway",
          "value": "name"
        }
      },
      "filters": {
        "date_start": "2018-05-17T18:46:14.646Z",
        "date_end": "2018-07-28T18:46:14.647Z",
        "campaign_filter": ["JNXLPjkA1jI2PEK0lNqP"],
        "metadata_filter": [{
          "value": "campaign_abc123",
          "name": "adwords_campaign"
        }]
      }
    }
}</pre>
                                <p class="col-code-p col-code-additional">Retrieve Response JSON</p>
                                <pre id="query-timeline-response" class="highlight-code language-json">
{
    "api_call_id": "4rG0OJYQnairJa4Z571Y",
    "api_call_processed": true,
    "code": 1,
    "count": 146,
    "results": [{
      "type_value": "06/06/18",
      "group_by_value": "Worldpay",
      "sum_amount_gross": 230.42
    }, {
      "type_value": "06/06/18",
      "group_by_value": "Authorize.net",
      "sum_amount_gross": 12.32
    }, {
      "type_value": "06/06/18",
      "group_by_value": "Stripe",
      "sum_amount_gross": 392.03
    }, {
      "type_value": "06/06/18",
      "group_by_value": "Braintree",
      "sum_amount_gross": 10.19
    }],
    "status": "DONE"
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="filters">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text filters">
                                <h2>Filters</h2>
                                <hr></hr>
                                <p>Each retrieve or query request can have multiple filters that can be applied.</p>
                                <p>Some filters only allow certain values, those values are explained in the list below. Invalid filters and/or values will be rejected and return an error.</p>

                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col no-content">
                        </div>
                    </div>
                </section>

                <section id="filters-list">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col last-section">
                            <div class="api-section-text filters-list">
                                <h3>Filters List</h3>
                                <hr></hr>
                                <p>Below are the applicable properties within the filters object. Each request type has its own set of allowed filters, and
                                    in some cases specific filter values.</p>
                                <p>The JSON request example shows a sale retrieve request, with the filters object containing multiple filters.</p>
                                <p><strong>Important</strong>: The date_start and date_end properties are required for all retrieve and query requests.</p>


                                <h4>Chargeback</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shop_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a RevCent Shop or third party shop.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    method_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular RevCent request method.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>sale_create</dt>
                                                        <dd>Transaction occurred when creating a sale.</dd>
                                                        <dt>subscription_renew</dt>
                                                        <dd>Transaction occurred when renewing a subscription.</dd>
                                                        <dt>trial_expire</dt>
                                                        <dd>Transaction occurred during trial expiration, either manually or via RevCent system.</dd>
                                                        <dt>pending_refund_process</dt>
                                                        <dd>Transaction occurred when refunding a transaction.</dd>
                                                        <dt>salvage_transaction_process</dt>
                                                        <dd>Transaction occurred when processing a salvage transaction.</dd>
                                                        <dt>usage_account_invoice_charge</dt>
                                                        <dd>Transaction occurred when charging a usage account invoice at the end of the usage billing period.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created</dt>
                                                        <dd>The chargeback was created.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Customer</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    customer_group_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a customer group.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>enabled</dt>
                                                        <dd>Customer is currently enabled.</dd>
                                                        <dt>disabled</dt>
                                                        <dd>Customer is currently disabled.</dd>
                                                        <dt>blocked</dt>
                                                        <dd>Customer is currently blocked.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                        <dt>lifetime_value</dt>
                                                        <dd>The sum amount_gross for all sales, subscription renewals and usage invoices.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Customer Card</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Fraud Detection</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shop_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a RevCent Shop or third party shop.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    method_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular RevCent request method.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>sale_create</dt>
                                                        <dd>Transaction occurred when creating a sale.</dd>
                                                        <dt>subscription_renew</dt>
                                                        <dd>Transaction occurred when renewing a subscription.</dd>
                                                        <dt>trial_expire</dt>
                                                        <dd>Transaction occurred during trial expiration, either manually or via RevCent system.</dd>
                                                        <dt>pending_refund_process</dt>
                                                        <dd>Transaction occurred when refunding a transaction.</dd>
                                                        <dt>salvage_transaction_process</dt>
                                                        <dd>Transaction occurred when processing a salvage transaction.</dd>
                                                        <dt>usage_account_invoice_charge</dt>
                                                        <dd>Transaction occurred when charging a usage account invoice at the end of the usage billing period.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created</dt>
                                                        <dd>The fraud detection was created.</dd>
                                                        <dt>false_positive</dt>
                                                        <dd>Whether the fraud detection is incorrect. I.e. The related payment is not actually fraud.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Pending Refund</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>processing</dt>
                                                        <dd>Original transaction has not yet settled, or RevCent has not processed the official refund. RevCent
                                                            processes pending refunds every 3 hours.</dd>
                                                        <dt>complete</dt>
                                                        <dd>Original transaction has been officially refunded with the originating gateway for the refund amount.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Product</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular product type.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>basic</dt>
                                                        <dd>Product does not have a subscription profile, trial period, quota unit or usage profile attached.</dd>
                                                        <dt>subscription</dt>
                                                        <dd>Product has a subscription profile attached.</dd>
                                                        <dt>subscription_only</dt>
                                                        <dd>Product has a subscription profile attached, without a trial period.</dd>
                                                        <dt>trial</dt>
                                                        <dd>Product has a trial period attached.</dd>
                                                        <dt>trial_only</dt>
                                                        <dd>Product has a trial period attached, without a subscription profile.</dd>
                                                        <dt>license_key</dt>
                                                        <dd>Product is a license key based product.</dd>
                                                        <dt>quota</dt>
                                                        <dd>Product is a quota based product.</dd>
                                                        <dt>usage</dt>
                                                        <dd>Product is a usage based product.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_group_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product group.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shop_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a RevCent Shop or third party shop.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_hierarchy_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular product hierarchy.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>parent</dt>
                                                        <dd>Product is a parent product.</dd>
                                                        <dt>child</dt>
                                                        <dd>Product is a child product, or variant, of a parent product.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>enabled</dt>
                                                        <dd>Product is currently enabled.</dd>
                                                        <dt>disabled</dt>
                                                        <dd>Product is currently disabled.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                        <dt>name</dt>
                                                        <dd>The product name.</dd>
                                                        <dt>price</dt>
                                                        <dd>The product price.</dd>
                                                        <dt>sku</dt>
                                                        <dd>The product SKU.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Product Sale</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>nocapture</dt>
                                                        <dd>No revenue has been captured.</dd>
                                                        <dt>captured</dt>
                                                        <dd>All revenue has been captured, but none settled.</dd>
                                                        <dt>partialcapture</dt>
                                                        <dd>Some revenue has been captured, but none settled.</dd>
                                                        <dt>settled</dt>
                                                        <dd>Some or all revenue has been settled.</dd>
                                                        <dt>void</dt>
                                                        <dd>All revenue, if any, refunded. Item void.</dd>
                                                        <dt>refund</dt>
                                                        <dd>Some revenue or remaining revenue refunded.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Sale</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shop_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a RevCent Shop or third party shop.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>nocapture</dt>
                                                        <dd>No revenue has been captured.</dd>
                                                        <dt>captured</dt>
                                                        <dd>All revenue has been captured, but none settled.</dd>
                                                        <dt>partialcapture</dt>
                                                        <dd>Some revenue has been captured, but none settled.</dd>
                                                        <dt>settled</dt>
                                                        <dd>Some or all revenue has been settled.</dd>
                                                        <dt>void</dt>
                                                        <dd>All revenue, if any, refunded. Item void.</dd>
                                                        <dt>refund</dt>
                                                        <dd>Some revenue or remaining revenue refunded.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>fraud_alert</dt>
                                                        <dd>A fraud alert was added to the sale.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                        <dt>is_upsell</dt>
                                                        <dd>The sale was marked as an upsell.</dd>
                                                        <dt>is_not_upsell</dt>
                                                        <dd>The sale was not marked as an upsell.</dd>
                                                    <p>
                                                        <strong>Pending Sale Filters</strong>
                                                    </p>
                                                    <p>Filter values applying to abandoned sales that were automatically processed by RevCent using Pending Sale Profiles. Prepend values below with <code>pending_sale_</code>, ex: pending_sale_payment_processed</p>
                                                    <dl class="dl-horizontal">
                                                        <dt>payment_processed</dt>
                                                        <dd>The abandoned sale was processed, regardless of result.</dd>
                                                        <dt>payment_success</dt>
                                                        <dd>The abandoned sale was recovered successfully.</dd>
                                                        <dt>payment_decline</dt>
                                                        <dd>The abandoned sale was processed and the payment was declined.</dd>
                                                        <dt>payment_fail</dt>
                                                        <dd>The abandoned sale was processed and the payment attempt failed.</dd>
                                                        <dt>payment_error</dt>
                                                        <dd>The abandoned sale was processed and ended with an error.</dd>
                                                        <dt>exclude_processed</dt>
                                                        <dd>Exclude sales that were processed by Revcent using Pending Sale Profiles.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Salvage Transaction</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    method_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular RevCent request method.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>sale_full</dt>
                                                        <dd>Salvage transaction was created when a sale was fully declined.</dd>
                                                        <dt>sale_partial</dt>
                                                        <dd>Salvage transaction was created when a sale was partially declined.</dd>
                                                        <dt>trial_expire</dt>
                                                        <dd>Salvage transaction was created expiring a trial.</dd>
                                                        <dt>subscription_renew</dt>
                                                        <dd>Salvage transaction was created renewing a subscription.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a payment profile.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>salvaged</dt>
                                                        <dd>Salvage transaction was successfully salvaged</dd>
                                                        <dt>not_salvaged</dt>
                                                        <dd>Salvage transaction has not been salvaged.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    subscription_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a subscription profile.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>

                                <h4>Shipping</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    fulfillment_account_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a fulfillment account.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>nocapture</dt>
                                                        <dd>No revenue has been captured.</dd>
                                                        <dt>captured</dt>
                                                        <dd>All revenue has been captured, but none settled.</dd>
                                                        <dt>partialcapture</dt>
                                                        <dd>Some revenue has been captured, but none settled.</dd>
                                                        <dt>settled</dt>
                                                        <dd>Some or all revenue has been settled.</dd>
                                                        <dt>void</dt>
                                                        <dd>All revenue, if any, refunded. Item void.</dd>
                                                        <dt>refund</dt>
                                                        <dd>Some revenue or remaining revenue refunded.</dd>
                                                        <dt>free</dt>
                                                        <dd>Shipping was marked as free, therefore no revenue.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shipping_provider_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>ups</dt>
                                                        <dd>UPS.</dd>
                                                        <dt>fedex</dt>
                                                        <dd>FedEx.</dd>
                                                        <dt>usps</dt>
                                                        <dd>USPS.</dd>
                                                        <dt>dhl</dt>
                                                        <dd>DHL.</dd>

                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shipping_status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>shipped</dt>
                                                        <dd>Item has been marked shipped by user, however not received by provider.</dd>
                                                        <dt>notshipped</dt>
                                                        <dd>Item has not been marked shipped by user.</dd>
                                                        <dt>received</dt>
                                                        <dd>Provider received the item.</dd>
                                                        <dt>delivered</dt>
                                                        <dd>Provider delivered the item to recipient.</dd>
                                                        <dt>error</dt>
                                                        <dd>An error occurred when RevCent attempted to get the shipping status from provider.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                        <dt>shipped_date</dt>
                                                        <dd>Date the item was shipped.</dd>
                                                        <dt>delivered_date</dt>
                                                        <dd>Date the item was delivered.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Subscription</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>active</dt>
                                                        <dd>The subscription is currently active.</dd>
                                                        <dt>trial</dt>
                                                        <dd>The subscription is currently inactive as the trial associated with it has yet to expire.</dd>
                                                        <dt>overdue</dt>
                                                        <dd>The subscription has at least one overdue renewal.</dd>
                                                        <dt>occurrence_limit</dt>
                                                        <dd>The subscription is no longer active as the number of allowed occurrences has been reached.</dd>
                                                        <dt>suspended</dt>
                                                        <dd>The subscription was suspended by the user.</dd>
                                                        <dt>cancelled</dt>
                                                        <dd>The subscription was cancelled by the user.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    subscription_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a subscription profile.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                        <dt>amount</dt>
                                                        <dd>The amount the subscription renews at.</dd>
                                                        <dt>next_renewal_date</dt>
                                                        <dd>The date the subscription is set to renew.</dd>
                                                        <dt>last_renewal_date</dt>
                                                        <dd>The date the subscription was last renewed.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Subscription Renewal</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a payment profile.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>captured</dt>
                                                        <dd>All revenue has been captured, but none settled.</dd>
                                                        <dt>settled</dt>
                                                        <dd>Some or all revenue has been settled.</dd>
                                                        <dt>refund</dt>
                                                        <dd>Some revenue or remaining revenue refunded.</dd>
                                                        <dt>void</dt>
                                                        <dd>All revenue, if any, refunded. Item void.</dd>
                                                        <dt>overdue</dt>
                                                        <dd>The subscription renewal was either fully or partially declined.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    subscription_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a subscription profile.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Tax</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>nocapture</dt>
                                                        <dd>No revenue has been captured.</dd>
                                                        <dt>captured</dt>
                                                        <dd>All revenue has been captured, but none settled.</dd>
                                                        <dt>partialcapture</dt>
                                                        <dd>Some revenue has been captured, but none settled.</dd>
                                                        <dt>settled</dt>
                                                        <dd>Some or all revenue has been settled.</dd>
                                                        <dt>void</dt>
                                                        <dd>All revenue, if any, refunded. Item void.</dd>
                                                        <dt>refund</dt>
                                                        <dd>Some revenue or remaining revenue refunded.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Transaction</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    gateway_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a gateway.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    method_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular RevCent request method.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>sale_create</dt>
                                                        <dd>Transaction occurred when creating a sale.</dd>
                                                        <dt>subscription_renew</dt>
                                                        <dd>Transaction occurred when renewing a subscription.</dd>
                                                        <dt>trial_expire</dt>
                                                        <dd>Transaction occurred during trial expiration, either manually or via RevCent system.</dd>
                                                        <dt>pending_refund_process</dt>
                                                        <dd>Transaction occurred when refunding a transaction.</dd>
                                                        <dt>salvage_transaction_process</dt>
                                                        <dd>Transaction occurred when processing a salvage transaction.</dd>
                                                        <dt>usage_account_invoice_charge</dt>
                                                        <dd>Transaction occurred when charging a usage account invoice at the end of the usage billing period.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a payment profile.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    result_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the initial gateway result of the transaction.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>approved</dt>
                                                        <dd>The merchant gateway approved the transaction.</dd>
                                                        <dt>declined</dt>
                                                        <dd>The merchant gateway declined the transaction.</dd>
                                                        <dt>error</dt>
                                                        <dd>The merchant gateway returned an error upon attempting transaction.</dd>
                                                        <dt>held</dt>
                                                        <dd>The merchant gateway placed a hold on the transaction.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>nocapture</dt>
                                                        <dd>No revenue has been captured.</dd>
                                                        <dt>captured</dt>
                                                        <dd>All revenue has been captured, but none settled.</dd>
                                                        <dt>partialcapture</dt>
                                                        <dd>Some revenue has been captured, but none settled.</dd>
                                                        <dt>settled</dt>
                                                        <dd>Some or all revenue has been settled.</dd>
                                                        <dt>void</dt>
                                                        <dd>All revenue, if any, refunded. Item void.</dd>
                                                        <dt>refund</dt>
                                                        <dd>Some revenue or remaining revenue refunded.</dd>
                                                        <dt>complete</dt>
                                                        <dd>Transaction is complete. Refund transactions only.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Trial</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>active</dt>
                                                        <dd>Trial is currently active.</dd>
                                                        <dt>expired</dt>
                                                        <dd>Trial expired and the resulting transaction was fully successful.</dd>
                                                        <dt>expiredpaymentpartialdecline</dt>
                                                        <dd>Trial expired and the resulting transaction(s) were partially successful.</dd>
                                                        <dt>expiredpaymentfulldecline</dt>
                                                        <dd>Trial expired and the resulting transaction(s) were fully declined.</dd>
                                                        <dt>expiredpaymenterror</dt>
                                                        <dd>Trial expired and the resulting transaction(s) produced an error with the merchant gateway.</dd>
                                                        <dt>inactive</dt>
                                                        <dd>Trial has not expired but has been deactivated by the user, thus preventing it from expiring.</dd>
                                                        <dt>cancelled</dt>
                                                        <dd>Trial has not expired but has been cancelled by the user.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <!-- <h4>Usage Account</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shop_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a RevCent Shop or third party shop.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>enabled</dt>
                                                        <dd>Item is enabled.</dd>
                                                        <dt>disabled</dt>
                                                        <dd>Item is disabled.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Usage Account Invoice</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    shop_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a RevCent Shop or third party shop.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>enabled</dt>
                                                        <dd>Item is enabled.</dd>
                                                        <dt>disabled</dt>
                                                        <dd>Item is disabled.</dd>
                                                        <dt>overdue</dt>
                                                        <dd>Item payment failed.</dd>
                                                        <dt>paid</dt>
                                                        <dd>Item was paid successfully.</dd>
                                                        <dt>expired</dt>
                                                        <dd>Item is expired without payment.</dd>
                                                        <dt>trial</dt>
                                                        <dd>Item is currently in a trial period.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Usage Item</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    usage_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a usage profile.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>enabled</dt>
                                                        <dd>Item is enabled.</dd>
                                                        <dt>disabled</dt>
                                                        <dd>Item is disabled.</dd>
                                                        <dt>replaced</dt>
                                                        <dd>Item was replaced.</dd>
                                                        <dt>trial</dt>
                                                        <dd>Item is currently in a trial period.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Usage Item Invoice</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    usage_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a usage profile.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    payment_type_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a payment type used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>credit_card</dt>
                                                        <dd>Credit card payment.</dd>
                                                        <dt>paypal</dt>
                                                        <dd>PayPal payment.</dd>
                                                        <dt>check_direct</dt>
                                                        <dd>Physical check payment, not ACH.</dd>
                                                        <dt>offline</dt>
                                                        <dd>Offline payment.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    status_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a particular status.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>enabled</dt>
                                                        <dd>Item is enabled.</dd>
                                                        <dt>disabled</dt>
                                                        <dd>Item is disabled.</dd>
                                                        <dt>overdue</dt>
                                                        <dd>Item payment failed.</dd>
                                                        <dt>paid</dt>
                                                        <dd>Item was paid successfully.</dd>
                                                        <dt>expired</dt>
                                                        <dd>Item is expired without payment.</dd>
                                                        <dt>trial</dt>
                                                        <dd>Item is currently in a trial period.</dd>
                                                        <dt>fraud</dt>
                                                        <dd>Fraud was detected.</dd>
                                                        <dt>chargeback</dt>
                                                        <dd>A chargeback occurred.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div>


                                <h4>Usage Item Entry</h4>
                                <hr>
                                <div class="card properties-collapse">
                                    <div class="card-header centit" role="tab">
                                        <a class="show-properties-toggle" data-toggle="collapse-next">Show Properties</a>
                                    </div>
                                    <div class="collapse" role="tabpanel">
                                        <div class="card-block">
                                            <hr class="card-block-first">
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_start
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The start date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    date_end
                                                    <div class="string-label"></div>
                                                    <div class="required-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The end date for item type created date range. Must be valid ISO_8601 format.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    page
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The page to request. Default is 1, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    limit
                                                    <div class="integer-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>The number of items per page. Default is 25, max is 100. Applicable only for retrieve requests.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    campaign_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a campaign.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    product_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a product.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    usage_profile_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being the RevCent ID for a usage profile.</p>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    usage_method_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual string values. Each value being a usage method used for the item.</p>
                                                    <p>
                                                        <strong>Accepted Values</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>increase</dt>
                                                        <dd>Usage was increased.</dd>
                                                        <dt>decrease</dt>
                                                        <dd>Usage was decreased.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    metadata_filter
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array of individual objects. Each object contains a "name" property and "value" property.</p>
                                                </div>
                                            </div>
                                            
                                            <hr>
                                            <div class="row">
                                                <div class="col-sm-5 schema-property-key text-right">
                                                    sort
                                                    <div class="array-label"></div>
                                                    <div class="optional-label"></div>
                                                </div>
                                                <div class="col-sm-7 schema-property-value">
                                                    <p>An array containing a single sort object. The object should contain a "field" property and "dir" property. The "dir" property can be "asc" or "desc" only.<br>Default: [{"field": "created_at", "dir": "desc"}]</p>
                                                    <p>
                                                        <strong>Sortable Fields</strong>
                                                    </p>
                                                    <dl class="dl-horizontal">
                                                        <dt>created_at</dt>
                                                        <dd>Date the item was created.</dd>
                                                        <dt>updated_at</dt>
                                                        <dd>Date the item was last updated.</dd>
                                                    </dl>
                                                </div>
                                            </div>
                                            <hr class="card-block-last">
                                        </div>
                                    </div>
                                </div> -->                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Request JSON</p>
                                <pre id="filters-request" class="highlight-code language-json">
{
    "request": {
      "type": "sale",
      "method": "retrieve",
      "multiple": true,
      "filters": {
        "date_start": "2018-05-14",
        "date_end": "2018-06-13",
        "page": 1,
        "limit": 25,
        "campaign_filter": ["O06jbPqPBgI8pXj5l1oz"],
        "status_filter": ["captured", "settled"],
        "metadata_filter": [{
          "name": "adwords_campaign",
          "value": "My Adwords Campaign"
        }]
      }
    }
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="pagination">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text pagination">
                                <h2>Pagination</h2>
                                <hr></hr>
                                <p>Pagination only applies to API retrieve requests which return more than one item (no item id specified). Query requests do not institute pagination in the results.</p>
                                <p>Pagination is necessary in order to prevent results from being too large, as well as prevent user systems from having to process too much data in memory.</p>
                                <p>Without pagination, a multiple type request could have thousands or more result items.</p>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col no-content">
                        </div>
                    </div>
                </section>

                <section id="pagination-example">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col">
                            <div class="api-section-text pagination-example">
                                <h3>Example</h3>
                                <hr></hr>
                                <p>This is an example of a sale multiple retrieve request. Different items have different filter fields. View the <a href="#filters">Filters</a> section for details on item specific filters.</p>


                                <h4>Request JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        request
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value ">
                                        <p>The main request object.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        type
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request type.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        method
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The request method.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        multiple
                                        <div class="boolean-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>Must equal true to retrieve multiple results.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        filters
                                        <div class="object-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>Default filters for a multiple retrieve request are below. View the <a href="#filters">Filters</a> section for details on item specific filters.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        date_start
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The start date for item created date range. Must be valid ISO_8601 format.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        date_end
                                        <div class="string-label"></div>
                                        <div class="required-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The end date for item created date range. Must be valid ISO_8601 format.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        page
                                        <div class="integer-label"></div>
                                        <div class="optional-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The page to request. Default is 1.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        limit
                                        <div class="integer-label"></div>
                                        <div class="optional-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The number of items per page. Default is 25, max is 100.</p>
                                    </div>
                                </div>
                                <div class="api-text-divider"></div>


                                <h4>Response JSON Schema</h4>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_id
                                        <div class="string-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The API call ID of the request. Every API request is assigned an ID.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        api_call_processed
                                        <div class="boolean-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>Indicates whether the API call was processed.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        code
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The result code for the request.</p>
                                        <ul class="list list-unstyled">
                                            <li>0 = Error</li>
                                            <li>1 = Successful</li>
                                        </ul>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        current_count
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The number of result items contained in the current page.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        current_page
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The current page of result items, same as requested page, default is page 1.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        total_count
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The total number of result items for the given request.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        total_pages
                                        <div class="integer-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>The total number of pages for the given request.</p>
                                    </div>
                                </div>
                                <hr>
                                <div class="row">
                                    <div class="col-sm-5 schema-property-key text-right">
                                        results
                                        <div class="array-label"></div>
                                    </div>
                                    <div class="col-sm-7 schema-property-value">
                                        <p>An array of objects, each object being a retrieved item. Depending on the request type, returned items are the same as an individual request.</p>
                                        <p>For example, a multiple sale retrieve request will return an array of objects, each object containing the same properties as a single sale retrieve request.</p>
                                        <p>To view the response schema of a multiple request, simply view the retrieve section of the request type on this page.</p>
                                    </div>
                                </div>
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col">
                            <div class="api-section-code">
                                <p class="col-code-p col-code-first">Request JSON</p>
                                <pre id="pagination-retrieve-request" class="highlight-code language-json">
{
    "request": {
      "type": "sale",
      "method": "retrieve",
      "multiple": true,
      "filters": {
        "date_start": "2018-05-14",
        "date_end": "2018-06-13",
        "page": 1,
        "limit": 25
      }
    }
}</pre>
                                <p class="col-code-p col-code-additional">Response JSON</p>
                                <pre id="pagination-retrieve-response" class="highlight-code language-json">
{
    "api_call_id": "ALWJVEy0ZOtWakBkWn50",
    "api_call_processed": true,
    "code": 1,
    "current_count": 25,
    "current_page": 1,
    "total_count": 100,
    "total_pages": 4,
    "results": []
}</pre>
                            </div>
                        </div>
                    </div>
                </section>

                <section id="last-section">
                    <div class="row api-section">
                        <div class="col-sm-6 api-section-col last-section">
                            <div class="api-section-text last-section">
                            </div>
                        </div>
                        <div class="col-sm-6 api-section-col api-section-code-col no-content">
                        </div>
                    </div>
                </section>
            </div>
        </div>
    </div>


    <script src="https://cdn.revcent.com/js/jquery.min.js"></script>
    <script src="https://cdn.revcent.com/js/bootstrap.min.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/validation/jquery.validate.min.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/validation/additional-methods.min.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/metisMenu/jquery.metisMenu.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/slimscroll/jquery.slimscroll.min.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/bootstrap-select/bootstrap-select.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/moment/moment.min.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/moment/moment-timezone.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/pace/pace.min.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/sweetalert/sweetalert.min.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/highlightjs/highlight.min.js"></script>
    <script src="https://cdn.revcent.com/js/plugins/lightbox/ekko-lightbox.min.js"></script>
    <script src="https://cdn.revcent.com/js/revcent.min.js"></script>
    <script src="https://www.google.com/recaptcha/api.js?onload=recaptchaLibLoaded&render=explicit" async defer></script>

    <script>
      $.ajaxSetup({
        headers: {
          'csrf-token': $("meta[name=_csrf]").attr('value')
        }
      });
    </script>
    <!-- Global site tag (gtag.js) - Google Ads: 661405838 -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=AW-661405838"></script>
    <script>
      window.dataLayer = window.dataLayer || [];

      function gtag() {
        dataLayer.push(arguments);
      }
      gtag('js', new Date());
      gtag('config', 'AW-661405838');
    </script>

    <script>
      var registerRequestRecaptchaWidget;
      var contactModalRecaptchaWidget;
      var demoRequestRecaptchaWidget;
      var revenuePartnerRequestRecaptchaWidget;
      var recaptchaLibLoaded = function () {
        let recaptcha_site_key = '6LcDsNUUAAAAAIpsHmkuI7Renzt8xNAl7HHItOou';
        if ($('#contact-revcent-form').length > 0) {
          contactModalRecaptchaWidget = grecaptcha.render('recaptcha_contact_modal', {
            'sitekey': recaptcha_site_key
          });
        }
        if ($('#recaptcha_demo_request').length > 0) {
          demoRequestRecaptchaWidget = grecaptcha.render('recaptcha_demo_request', {
            'sitekey': recaptcha_site_key
          });
        }
        if ($('#recaptcha_revenue-partner_request').length > 0) {
          revenuePartnerRequestRecaptchaWidget = grecaptcha.render('recaptcha_revenue-partner_request', {
            'sitekey': recaptcha_site_key
          });
        }
        if ($('#recaptcha_register_request').length > 0) {
          registerRequestRecaptchaWidget = grecaptcha.render('recaptcha_register_request', {
            'sitekey': recaptcha_site_key
          });
        }
      };
      $(document).ready(function () {
        $('.products-parent-list-item').mouseover(function () {
          $('.products-sub-list-wrap').addClass('hidden');
          $('.products-' + $(this).attr('data-productparent') + '-wrap').removeClass('hidden');
        });
        $('.products-dropdown-ul').on('hide.bs.dropdown', function () {
          $('.products-sub-list-wrap').addClass('hidden');
          $('.products-featured-wrap').removeClass('hidden');
        });

        $('.lobtn').click(function () {
          $.ajax({
            type: 'POST',
            url: '/auth/logout',
            dataType: "json",
            success: function (x) {
              window.location.replace('/');
            }
          });
        });


        $('#revenue-partner-request-submit').click(function () {

          let revenue_partner_request_recaptcha_token = '';
          if ($('#revenue-partner-request-form').valid()) {
            if (typeof revenuePartnerRequestRecaptchaWidget !== 'undefined' && grecaptcha.getResponse(revenuePartnerRequestRecaptchaWidget) !== '') {
              revenue_partner_request_recaptcha_token = grecaptcha.getResponse(revenuePartnerRequestRecaptchaWidget);
              submitDemoRequestForm();
            } else {
              swal('Error', 'Please verify you are not a robot.', 'warning');
            }
          }


          function submitDemoRequestForm() {
            $('body').append('<img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=1769338&conversionId=1823314&fmt=gif" />');
            var btn_id = "#revenue-partner-request-submit";
            var prefix = 'revenue-partner-request-';
            $(btn_id).addClass('disabled please-wait-btn');
            $(btn_id).text('Submitting. Please Wait...');
            $.ajax({
              type: 'POST',
              url: '/revenue-partner-request',
              dataType: "json",
              data: {
                first_name: $('#' + prefix + 'first-name').val(),
                last_name: $('#' + prefix + 'last-name').val(),
                email: $('#' + prefix + 'email').val(),
                phone: $('#' + prefix + 'phone').val(),
                company: $('#' + prefix + 'company').val(),
                website: $('#' + prefix + 'website').val(),
                recaptcha_token: revenue_partner_request_recaptcha_token,
                submission_path: window.location.pathname
              },
              success: function (x) {
                if (x.code === 0) {
                  $(btn_id).removeClass('disabled please-wait-btn');
                  $(btn_id).text('Submit');
                  swal("Error", x.message, "warning");
                } else {
                  swal({
                    title: "Partner Request Sent",
                    text: "Thanks for contacting us. We will respond ASAP.",
                    type: "success",
                    showConfirmButton: false
                  });
                  conversionSubmission('revenue_partner_form', function () {
                    window.setTimeout(function () {
                      window.location.href = "https://revcent.com";
                    }, 4000);
                  });
                }
              }
            });
          }
        });

        $('#demo-request-submit').click(function () {

          let demo_request_recaptcha_token = '';
          if ($('#demo-request-form').valid()) {
            if (typeof demoRequestRecaptchaWidget !== 'undefined' && grecaptcha.getResponse(demoRequestRecaptchaWidget) !== '') {
              demo_request_recaptcha_token = grecaptcha.getResponse(demoRequestRecaptchaWidget);
              submitDemoRequestForm();
            } else {
              swal('Error', 'Please verify you are not a robot.', 'warning');
            }
          }


          function submitDemoRequestForm() {
            var btn_id = "#demo-request-submit";
            var prefix = 'demo-request-';
            $(btn_id).addClass('disabled please-wait-btn');
            $(btn_id).text('Submitting. Please Wait...');
            $.ajax({
              type: 'POST',
              url: '/demo-request',
              dataType: "json",
              data: {
                first_name: $('#' + prefix + 'first-name').val(),
                last_name: $('#' + prefix + 'last-name').val(),
                email: $('#' + prefix + 'email').val(),
                phone: $('#' + prefix + 'phone').val(),
                company: $('#' + prefix + 'company').val(),
                website: $('#' + prefix + 'website').val(),
                recaptcha_token: demo_request_recaptcha_token,
                submission_path: window.location.pathname
              },
              success: function (x) {
                if (x.code === 0) {
                  $(btn_id).removeClass('disabled please-wait-btn');
                  $(btn_id).text('Submit');
                  swal("Error", x.message, "warning");
                } else {
                  swal({
                    title: "Demo Request Sent",
                    text: "Thanks for contacting us. We will respond ASAP.",
                    type: "success",
                    showConfirmButton: false
                  });
                  conversionSubmission('demo_form', function () {
                    window.setTimeout(function () {
                      window.location.href = "https://revcent.com";
                    }, 4000);
                  });
                }
              }
            });
          }
        });

        $('#send-contact-revcent-btn').click(function () {
          var btn_id = "#send-contact-revcent-btn";
          let contact_modal_recaptcha_token = '';
          if ($('#contact-revcent-form').valid()) {
            if (typeof contactModalRecaptchaWidget !== 'undefined' && grecaptcha.getResponse(contactModalRecaptchaWidget) !== '') {
              contact_modal_recaptcha_token = grecaptcha.getResponse(contactModalRecaptchaWidget);
              submitContactForm();
            } else {
              swal('Error', 'Please verify you are not a robot.', 'warning');
            }
          }

          function submitContactForm() {
            $(btn_id).addClass('disabled please-wait-btn');
            $(btn_id).text('Submitting. Please Wait...');
            $.ajax({
              type: 'POST',
              url: '/contact-revcent',
              dataType: "json",
              data: {
                first_name: $('#contact-revcent-modal-first-name').val(),
                last_name: $('#contact-revcent-modal-last-name').val(),
                email: $('#contact-revcent-modal-email').val(),
                message: $('#contact-revcent-modal-message').val(),
                recaptcha_token: contact_modal_recaptcha_token
              },
              success: function (x) {
                if (x.code === 0) {
                  $(btn_id).removeClass('disabled please-wait-btn');
                  $(btn_id).text('Submit');
                  swal("Error", x.message, "warning");
                } else {
                  swal({
                    title: "Contact Form Sent",
                    text: "Thanks for contacting us. We will respond ASAP.",
                    type: "success",
                    showConfirmButton: false
                  });
                  conversionSubmission('contact_form', function () {
                    window.setTimeout(function () {
                      window.location.reload()
                    }, 4000);
                  });
                }
              }
            });
          }
        });

        function conversionSubmission(submission_type, callback) {
          $('body').append('<img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=1769338&conversionId=1823314&fmt=gif" />');
          gtag('event', 'conversion', {
            'send_to': 'AW-661405838/tqLWCPbNkMkBEI6BsbsC'
          });
          callback();
        }

        $(function () {
          $('[data-toggle="popover"]').popover()
        })
        $(function () {
          $('[data-toggle="tooltip"]').tooltip()
        })
        $('body.canvas-menu .sidebar-collapse').slimScroll({
          height: '100%',
          railOpacity: 0.9
        });
        $(document).on("click", "a.scroll-to-link", function (a) {
          if (this.hash !== "") {
            event.preventDefault();
            var hash = this.hash;
            $('html, body').animate({
              scrollTop: $(hash).offset().top
            }, 20, function () {
              window.location.hash = hash;
            });
          }
        });
      });

      $('.revcent-video').one("click", function () {
        var video = this;
        toggleControls(video, function (a) {
          video.play();
        });
      });

      function toggleControls(video, callback) {
        if (video.hasAttribute('controls')) {} else {
          video.setAttribute('controls', 'controls');
        }
        callback();
      }
      moment.tz.setDefault('Etc/GMT+0');
    </script>

    <!-- Facebook Pixel Code 
    <script>
      ! function (f, b, e, v, n, t, s) {
        if (f.fbq) return;
        n = f.fbq = function () {
          n.callMethod ?
            n.callMethod.apply(n, arguments) : n.queue.push(arguments)
        };
        if (!f._fbq) f._fbq = n;
        n.push = n;
        n.loaded = !0;
        n.version = '2.0';
        n.queue = [];
        t = b.createElement(e);
        t.async = !0;
        t.src = v;
        s = b.getElementsByTagName(e)[0];
        s.parentNode.insertBefore(t, s)
      }(window, document, 'script',
        'https://connect.facebook.net/en_US/fbevents.js');
      fbq('init', '984779368674352');
      fbq('track', 'PageView');
    </script>
    <noscript><img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=984779368674352&ev=PageView&noscript=1" /></noscript>
    End Facebook Pixel Code -->


    <script>
      // $.ajax({
      //   type: 'POST',
      //   url: '/public-page-visit' + window.location.search,
      //   dataType: "json",
      //   data: {
      //     page_path: window.location.pathname
      //   },
      //   success: function (x) {
      //     //console.log(x);
      //   }
      // });
    </script> 

 <link rel="stylesheet" href="https://cdn.revcent.com/css/plugins/highlightjs/icy-dark.css" type="text/css" />
 <script>
     $(document).ready(function () {
         var url_hash = window.location.hash;
         
         function prettyPrintJson() {
             hljs.configure({
                 cssSelector: '.highlight-code'
             });
             hljs.highlightAll();
             loadLabels();
         }

         function prettyPrintJson3() {
             $('.api-section-code pre').each(function (i) {
                 $(this).addClass('theme-tron');
                 $(this).removeClass('prettyprinted');
             });
             loadLabels();
         }


         function loadLabels() {
             $('.required-label').html('<span class="label-doc label-doc-required">Required</span>');
             $('.optional-label').html('<span class="label-doc label-doc-optional">Optional</span>');
             $('.string-label').html('<span class="label-doc label-doc-string">String</span>');
             $('.integer-label').html('<span class="label-doc label-doc-integer">Integer</span>');
             $('.boolean-label').html('<span class="label-doc label-doc-boolean">Boolean</span>');
             $('.float-label').html('<span class="label-doc label-doc-float">Float</span>');
             $('.object-label').html('<span class="label-doc label-doc-object">Object</span>');
             $('.array-label').html('<span class="label-doc label-doc-object">Array</span>');
             $('.or-label').html('<span class="or-label">-- or --</span>');
             loadScrollSpy();
         };

         function loadScrollSpy() {
             $("#main-doc-content").scrollspy({
                 target: "#sidebar-nav-wrap",
                 offset: 40
             });
             $(window).load(function () {
                 scrollToSection();
             });
         }


         $(document).on("click", ".docs-info-modal-link", function (a) {
             var topic = $(this).attr('data-topic');
             var modal_content = getModalBody(topic);
             $('#docs-info-modal-body').html(modal_content.body);
             $('#docs-info-modal-title').html(modal_content.title);
             $('#docs-info-modal').modal('show')
         });


         $(document).on("click", "#main-doc-sidebar a", function (a) {
             if (typeof this.hash !== 'undefined' && this.hash !== '' && typeof $(this.hash).offset() !== 'undefined') {
                 window.location.hash = this.hash;
                 scrollToSection();
             }
         });


         function scrollToSection() {
             var url_hash = window.location.hash;
             if (typeof url_hash !== 'undefined' && url_hash !== '' && typeof $(url_hash).offset() !== 'undefined') {
                 $('html, body').animate({
                     scrollTop: $(url_hash).offset().top
                 }, 20, function () {
                     window.location.hash = url_hash;
                 });
             }
         }


         $('body').on('click.collapse-next.data-api', '[data-toggle=collapse-next]', function (e) {
             var tbtn = $(this);
             var $target = tbtn.parent().next();
             tbtn.toggleClass('hpr');
             if (tbtn.hasClass('hpr')) {
                 tbtn.html('Hide Properties');
             } else {
                 tbtn.html('Show Properties');
             }
             $target.data('bs.collapse') ? $target.collapse('toggle') : $target.collapse()
         });

         $(document).on('click', '[data-toggle="lightbox"]', function (event) {
             event.preventDefault();
             $(this).ekkoLightbox();
         });

         prettyPrintJson();
     });
 </script> <script>
   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
   })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

   ga('create', 'UA-103661703-1', 'auto');
   ga('send', 'pageview');

 </script>
 <!-- <script async src="https://www.googletagmanager.com/gtag/js?id=AW-837703824"></script>
 <script>
   window.dataLayer = window.dataLayer || [];
   function gtag(){dataLayer.push(arguments);}
   gtag('js', new Date());
   gtag('config', 'AW-837703824');
 </script> --> </body>

</html>