Knowledge Base

Renew SSL Certificate Orders Using the API

When you want to renew an existing SSL certificate order using the API. This article explains renewal parameters, invoice options, discount handling, customer billing behavior, and response details for SSL certificate renewals.

Description

Renews an existing SSL Certificate order.

Parameters

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Your Live Account Reseller Id
api-key	String	Required	An alphanumeric code that can be used to authenticate your API calls
order-id	Integer	Required	-
months	Integer	Required	The number of months for which the certificate is to be renewed.
invoice-option	String	Required	This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer: NoInvoice: This will not raise any Invoice. The Order will be renewed PayInvoice: This will raise an Invoice and: if there is sufficient balance in the Customer's Debit Account, then the Invoice will be paid and the Order will be renewed. if there is insufficient balance in the Customer's Debit Account, then the Order will remain pending in the system. KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be Renewed. OnlyAdd: This will raise an Invoice for the Customer to pay later. The Order renewal request will remain pending.
discount-amount	Float	Optional	Discount amount for the order value.

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/sslcert/renew.xml?auth-userid=0&api-key=key&order-id=0&months=1&invoice-option=NoInvoice&discount-amount=0.00

Response

Returns a hash map of the result of the Renew operation.

Did you find this article helpful?