Renew

KB Tags associated with this article:
Use all tags
KB Tags
acronis backups
Body

Description

Renews the backup order.

HTTP Method

POST

Example Test URL Request

US Location https://test.httpapi.com/api/backup/us/renew.json?auth-userid=0&api-key=key&backup-order-id=0&months=0&invoice-option=NoInvoice&discount-amount=0.00&auto-renew=true
Asia Location https://test.httpapi.com/api/backup/asia/renew.json?auth-userid=0&api-key=key&backup-order-id=0&months=0&invoice-option=NoInvoice&discount-amount=0.00&auto-renew=true

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
backup-order-id Integer Required The order id of the hosting order for which you would want to renew the Acronis backup order
months Integer Required The number of months for which the Order is to be placed
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
discount-amount Float Optional Discount amount for the order value.

Response

Returns a hash map containing the below details:

  • Order ID of the Backup Order (entityid)

  • Backup Order Name (description)

  • Action Type (actiontype)

  • Description of the Backup Order Action (actiontypedesc)

  • Action ID of the Renew Action (eaqid)

  • Order Action Status (actionstatus)

  • Description of the renew action status (actionstatusdesc)

  • Invoice ID of the invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Customer ID associated with the Backup Order (customerid)

  • Discount Amount (discount-amount)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.