deleteAddon — Deleting SiteLock PCI compliance product

SiteLock PCI Compliance must be deleted using a specific subscription ID in order to ensure that users with multiple PCI Compliance subscriptions only remove those that are associated with the Merchant ID they intend.

See Retrieving account subscription statuses for information on retrieving specific subscription IDs on demand. This request will also return associated MIDs to ensure the proper subscription is deleted.

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

    • deleteAddon: The method name

      • addonInfo: (Repeatable) The subscription to remove. Deletions of this and other products that fall under this request may be commingled, as long as each has a separate addonInfo element.

        • subscription_id: The unique value used to identify the instance of the service

While it won’t cause an error to specify an account or site id with the deletion request, as is done in other calls to deleteAddon, this should be avoided when deleting by subscription ID if possible. Each subscription is already associated with an account, and nearly all are associated with a specific site, so this information is implied by the subscription ID. If the specified account, site, and subscription IDs don’t all point to the same account and site (when applicable), this will cause the request to fail.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <deleteAddon>
        <addonInfo>
            <subscription_id>442676</subscription_id>
        </addonInfo>
    </deleteAddon>
</SiteLockOnlineRequest>

Response format

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

    • deleteAddon: The method name

      • addonStatuses: A list of PCI Compliance subscriptions that were removed

        • addonStatus: (Repeatable) This element corresponds to the addonInfo element in the request

          • account_id: The SiteLock account ID determined by the subscription_id in the request

          • site_id: The SiteLock site ID from the subscription_id in the request

          • subscription_id: The ID of the deleted subscription

          • status: Can be one of the following values:

            • ok: Success return value

            • error: Error return value. The message element contains more detail.

          • code: This element is present when status is error.

          • message: The detailed success or error message

Example response

<SiteLockOnlineResponse>
    <deleteAddon>
        <addonStatuses>
            <addonStatus>
                <status>ok</status>
                <message>PCI subscription deleted ok</message>
                <account_id>123456</account_id>
                <site_id>654321</site_id>
                <subscription_id>442676</subscription_id>
            </addonStatus>
        </addonStatuses>
    </deleteAddon>
</SiteLockOnlineResponse>