getStatus — Retrieving SiteLock subscriptions statuses

The getStatus method retrieves the current billing status of SiteLock accounts. The results can be used to track SiteLock subscription upgrades, update your internal tracking of SiteLock accounts, verify billing reports, and even report back to your customers their current SiteLock account information.

The read-only 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

    • getStatus: The method name

      • accountInformation: Contains one of the elements that identify the SiteLock account. The value passed in is used to locate and return information about the account, provided that the located account belongs to the reseller calling this API method.

        • id: The SiteLock account ID

        • login: The login ID of the user associated with the account

        • domain: The domain name

        • site_id: The SiteLock site ID

        • reseller_account_id: The partner’s assigned account ID as specified in the provisionAccount method.

          We recommend that you use id or login to retrieve the account subscription status.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getStatus>
        <accountInformation>
            <id>152006</id>
        </accountInformation>
    </getStatus>
</SiteLockOnlineRequest>

Response format

  • SiteLockOnlineResponse: This element is used to delineate the full API response.

    • getStatus: The method name

      • accountInformation: The account details

        • name: The name of the account owner

        • addons: A list of add-ons

          • addon: (Repeatable) An add-on

            • amount: The amount provided by the partner in the provisioning call (displays the list price if no amount was provided)

            • frequency: The billing period (in months)

            • next_renewal_at: The date of the next renewal

            • subscription: The product ID of the service

            • subscription_id: The unique ID of the instance of the service

            • subscription_plan_name: The product name

            • subscription_start_date: The start date of the subscription

        • id: The ID of the account

        • isTest: Specifies whether this account is a test account for the partner (for example, a real account that shouldn’t be billed for). The possible values are yes and no.

        • status: The status of the account. The possible values are active and inactive.

      • siteInformation: The site details

        • site: The subscription information for a site

          • addons: A list of add-ons

            • addon: (Repeatable) An add-on

              • amount: The amount provided by the partner in the provisioning call (displays the list price if no amount was provided)

              • billing_authority: The owner of the billing relationship (partner or SiteLock)

              • frequency: The billing period (in months)

              • mid: (Obsolete) This element is blank. It’s retained for compatibility purposes only.

              • next_renewal_at: The date of the next renewal

              • subscription: The product ID of the service

              • subscription_id: The unique ID of the instance of the service

              • subscription_plan_name: The product name

              • subscription_start_date: The start date of the subscription

                The following elements are present when the site has a scan subscription plan:

          • alerts_email: The email address to which notifications will be sent

          • amount: The amount provided by the partner in the provisioning call (displays the list price if no amount was provided)

          • billing_authority: The owner of the billing relationship (partner or SiteLock)

          • frequency: The billing period (in months)

          • next_renewal_at: The date of the next renewal

          • subscription: The product ID of the service

          • subscription_id: The unique ID of the instance of the service

          • compliance: The general compliance status of the site. The possible values are:

            • Pending: The first set of scans hasn’t been completed, results are pending.

            • Verified: The scans found no issues.

            • Warning: One or more scans found issues, but the user is still within the 3-day grace period to resolve them. The Trust Seal is displayed.

            • Noncompliant: One or more scans found that at least one issue remains unresolved after the 3-day grace period (the status was warning before). The Trust Seal isn’t displayed.

            • Provisional: SiteLock created a fake site for a PCI subscription that was provisioned for an account with no associated sites.

          • domain: The domain name

          • frequency: The billing period (in months)

          • over_limit: Indicates if the site contains more pages than the current plan provides for (1 or 0)

          • page_limit: The current limit on the number of pages that can be scanned

          • pages_checked: The number of pages that were scanned

          • site_id: The ID of the site

          • site_status: The status of the site (active or inactive)

          • subscription: The product ID of the service

          • subscription_id: The unique ID of the instance of the service

          • subscription_plan_name: The product name

          • subscription_start_date: The start date of the subscription

          • subscription_type: The type of subscription (plan or bundle)

          • trusted_domain: Indicates if the domain ownership was verified (yes and no)

      • users: A list of users that belong to the account

        • user: (Repeatable) The user details

          • name: The user’s name

          • email: The user’s email address

          • login: The user’s login

          • owner: Indicates whether the user is the owner of the account (yes or no)

Example success response

<SiteLockOnlineResponse>
    <getStatus>
        <accountInformation>
            <name>John Doe</name>
            <addons>
                <addon>
                    <amount>14.00</amount>
                    <billing_authority>partner</billing_authority>
                    <frequency>1</frequency>
                    <next_renewal_at>2022-10-26</next_renewal_at>
                    <subscription>2831</subscription>
                    <subscription_id>16571467</subscription_id>
                    <subscription_plan_name>SiteLock PCI Compliance</subscription_plan_name>
                    <subscription_start_date>2021-07-26 09:54:41</subscription_start_date>
                </addon>
                <addon>
                    <amount>14.00</amount>
                    <billing_authority>partner</billing_authority>
                    <frequency>1</frequency>
                    <next_renewal_at>2018-10-26</next_renewal_at>
                    <subscription>2831</subscription>
                    <subscription_id>16571469</subscription_id>
                    <subscription_plan_name>SiteLock PCI Compliance</subscription_plan_name>
                    <subscription_start_date>2018-07-26 09:56:14</subscription_start_date>
                </addon>
                ...
            </addons>
            <id>243043</id>
            <isTest>no</isTest>
            <status>active</status>
        </accountInformation>
        <siteInformation>
            <site>
                <addons>
                    <addon>
                        <amount>14.00</amount>
                        <billing_authority>sitelock</billing_authority>
                        <frequency>1</frequency>
                        <next_renewal_at>2022-08-18</next_renewal_at>
                        <subscription>2900</subscription>
                        <subscription_id>19801617</subscription_id>
                        <subscription_plan_name>SiteLock TrueShield: Basic</subscription_plan_name>
                        <subscription_start_date>2021-07-18 08:38:21</subscription_start_date>
                    </addon>
                </addons>
                <alerts_email>[email protected]</alerts_email>
                <amount>18.00</amount>
                <billing_authority>sitelock</billing_authority>
                <compliance>Noncompliant</compliance>
                <domain>example.com</domain>
                <frequency>1</frequency>
                <next_renewal_at>2022-12-22</next_renewal_at>
                <over_limit>0</over_limit>
                <page_limit>2500</page_limit>
                <pages_checked>19</pages_checked>
                <site_id>14318393</site_id>
                <site_status>active</site_status>
                <subscription>86</subscription>
                <subscription_id>30507274</subscription_id>
                <subscription_plan_name>360-Degree Security Scan: Enterprise</subscription_plan_name>
                <subscription_start_date>2021-11-22 08:38:51</subscription_start_date>
                <subscription_type>plan</subscription_type>
                <trusted_domain>yes</trusted_domain>
            </site>
            ...
        </siteInformation>
        <users>
            <user>
                <name>John Doe</name>
                <email>[email protected]</email>
                <login>john</login>
                <owner>yes</owner>
            </user>
            ...
        </users>
    </getStatus>
</SiteLockOnlineResponse>

Example error response

The API responds with a result of Success in every case except when you have passed in an invalid account_id.

<SiteLockOnlineResponse>
    <getStatus>
        <error>account_id not found</error>
    </getStatus>
</SiteLockOnlineResponse>

Error codes

  • Account exists but is owned by a different reseller

  • Account not found