getPlanList — Retrieving a list of plans

The getPlanList method retrieves a list of current plans and their details for a partner account.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
  - partner: (Optional) The brand name to use in messaging
- getPlanList: The method name

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getPlanList />
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getPlanList: The method name
  - reseller_login: [attribute] - The reseller’s login name
  - product: (Repeatable) A SiteLock plan, bundle, or add-on
    
    name: [attribute] - The name of the plan, bundle, or add-on
    
    auto_renewal: [attribute] - Specifies whether the subscription will be automatically renewed. The value can be yes or no.
    
    full_refund_days: [attribute] - The period (in days) during which a full refund can issued to the user
    
    id: [attribute] - The ID of the product
    
    in_partner_checkout_flow: [attribute] - Available to users as a dashboard upgrade. The possible values are 1 and 0.
    
    invoice: [attribute] - Configured by a SiteLock account manager
    
    partner_rev_share: [attribute] - Configured by a SiteLock account manager
    
    price: [attribute] - Configured by a SiteLock account manager
    
    product_category: [attribute] - The product category
    
    product_description: [attribute] - The description of the product
    
    refundable_renewals: [attribute] - Configured by a SiteLock account manager
    
    requires_dns_changes: [attribute] - Specifies whether this product requires changes in the DNS records. The value can be yes or no.
    
    requires_ftp_creds: [attribute] - Specifies whether this product requires FTP credentials. The value can be yes or no.
    
    term: [attribute] - The term of the license in months.
    
    type: [attribute] - The type of the product. The value can be one of the following: plan, bundle, or addon.
    
    features: A list of product feautures
    
    feature: (Repeatable) A product feature

Example response

<SiteLockOnlineResponse>
    <getPlanList reseller_login="johndoe">
        <product name="SiteLock SMART 911 - One-time Scan" auto_renewal="yes" full_refund_days="0" id="10742" in_partner_checkout_flow="no" invoice="299.00" partner_rev_share="" price="" product_category="ES" product_description="" refundable_renewals="0" requires_dns_changes="no" requires_ftp_creds="yes" term="0" type="addon">
            <features>
                <feature>Modify SMART Settings</feature>
                <feature>PatchMan Warn(daily)</feature>
                <feature>SMART(daily)</feature>
                <feature>SMART Auto Fix</feature>
                <feature>SMART DB Auto Fix</feature>
                <feature>SMART/Database(hourly)</feature>
            </features>
        </product>
         <product name="Secure VIP (annual billed annually)" auto_renewal="yes" full_refund_days="30" id="795" in_partner_checkout_flow="no" invoice="2148.00" partner_rev_share="" price="" product_category="SCAN" product_description="" refundable_renewals="0" requires_dns_changes="yes" requires_ftp_creds="yes" term="12" type="bundle">
            <features>
                <feature>911 Investigative Concierge escalation</feature>
                <feature>Access to WAF Configuration</feature>
                <feature>Bad Bot Blocking</feature>
                <feature>Concierge supported WAF configuration</feature>
                <feature>Customer's DV SSL Certificate on TrueShield</feature>
                <feature>Domain Name Verification</feature>
                <feature>Downloadable Firewall Report for PCI</feature>
                <feature>Malicious Server Script Protection</feature>
                <feature>Malware Scan(2500 daily)</feature>
                <feature>Modify SMART Settings</feature>
                <feature>OWASP 10 Protection</feature>
                ...
            </features>
        </product>
        <product name="360-Degree Security Scan: Basic" auto_renewal="yes" full_refund_days="7" id="931" in_partner_checkout_flow="no" invoice="9.99" partner_rev_share="" price="" product_category="SCAN" product_description="" refundable_renewals="0" requires_dns_changes="no" requires_ftp_creds="no" term="1" type="plan">
            <features>
                <feature>Domain Name Verification</feature>
                <feature>Malware Scan(25 daily)</feature>
                <feature>Platform Scan(daily)</feature>
                <feature>Risk Score(daily)</feature>
                <feature>Spam Scan(daily)</feature>
                <feature>SQL Injection Scan(annual)</feature>
                <feature>SSL Scan(daily)</feature>
                <feature>Trust Seal</feature>
                <feature>Vulnerability Scan(annual)</feature>
                <feature>XSS Scan(annual)</feature>
            </features>
        </product>
        <product name="SiteLock Firewall & CDN: Pro" auto_renewal="yes" full_refund_days="0" id="12345" in_partner_checkout_flow="no" invoice="123.99" partner_rev_share="0.00%" price="123.99" product_category="ANP" product_description="" refundable_renewals="0" requires_dns_changes="yes" requires_ftp_creds="no" term="12" type="addon">
            <features>
                <feature>Bad Bot Blocking</feature>
                <feature>Concierge supported WAF configuration</feature>
                <feature>Customer's DV SSL Certificate on TrueShield</feature>
                <feature>OWASP 10 Protection</feature>
                <feature>Page Protect with Email</feature>
                <feature>SiteLock's SSL Certificates on TrueShield</feature>
                <feature>TrueReview Report(weekly)</feature>
                <feature>TrueShield</feature>
            </features>
        </product>
        ...
    <getPlanList />
</SiteLockOnlineResponse>