adjustRenewal — Modifying the renewal date of an existing subscription

The adjustRenewal method modifies the renewal date of an existing subscription.

While specifying the same subscription multiple times within a single request doesn’t explicitly generate an error, only the first attempt to modify the date is applied. All subsequent attempts to change the date in the same request are ignored. Subsequent requests to change the subscription may be made at a later time.

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

    • adjustRenewal: The method name

      • subscription: The subscription information

        • id: The ID of the subscription to be adjusted

        • renewal_date: The date to which to reset the subscription’s renewal_date. This date must contain the year, month and day, and may optionally contain the time. The format is somewhat flexible, but it’s recommended that it be expressed following the strftime string: %Y-%m-%d %H:%M:%S. The string passed is parsed, and an error is returned if the date cannot be ascertained.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>pass</password>
    </authentication>
    <adjustRenewal>
        <subscription>
            <id>111</id>
            <renewal_date>2014-06-06 23:23:23</renewal_date>
        </subscription>
        <subscription>
            <id>222</id>
            <renewal_date>not a valid date</renewal_date>
        </subscription>
    </adjustRenewal>
</SiteLockOnlineRequest>

Response format

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

    • adjustRenewal: The method name

      • status: The subscription status. The value can be one of the following:

        • ok: All operations completed successfully.

        • mixed: Some operations completed successfully.

        • fail: No operations completed successfully.

      • subscriptions: The subscription information

        • subscription: (Repeatable) A subscription

          • id: The ID of the subscription that was adjusted

          • renewal_date: The date to which the result was set, if any

          • status: Either ok or error

          • code: If an error, a related error code (see the following table)

          • message: If an error, a message explaining the error (see the following table)

Example response

<SiteLockOnlineResponse>
    <adjustRenewal>
        <status>mixed</status>
        <subscriptions>
            <subscription>
                <id>111</id>
                <renewal_date>2014-06-06 23:23:23</renewal_date>
                <status>ok</status>
            </subscription>
            <subscription>
                <id>222</id>
                <code>IRD</code>
                <message>Cannot set renewal date in the past, or invalid date: not a valid date</message>
                <status>error</status>
            </subscription>
        </subscriptions>
    </adjustRenewal>
</SiteLockOnlineResponse>

Possible error messages/codes

Error code Error message Description

ISI

Invalid Subscription ID: %s

The noted subscription couldn’t be found or belongs to a different reseller.

IRD

Cannot set renewal date in the past, or invalid date: %s

The noted date either couldn’t be parsed and validated or it’s in the past.