PUT api/AutoRenew/{id}?user={user}

Update the status of an auto renewal

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id of the auto renewal	integer	Required
user	Optional user handle - if empty logged in user will be used	string	None.

Body Parameters

Autorenewal details - specify TotalTtc if verifying funds and set status to ready to pass/repass

AutoRenewUpdate

Name	Description	Type	Additional information
Status	Status - new, ready, pending, completed, failed, error. Setting the status to ready will relaunch the process	string	Required
VerifyAccount	Flag to indicate if the account should be verified for this renewal	boolean	None.
TotalTtc	Total ttc of the renewal	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "VerifyAccount": true,
  "TotalTtc": 1.0
}

application/xml, text/xml

Sample:

<AutoRenewUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.AutoRenew">
  <Status>sample string 1</Status>
  <TotalTtc>1</TotalTtc>
  <VerifyAccount>true</VerifyAccount>
</AutoRenewUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An autorenew on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error

AutoRenew

Name	Description	Type	Additional information
Id	Id of autorenewal	integer	None.
TransactionId	Transaction id of the renewal order	string	None.
ObjectHandle	Handle of the object	string	None.
Class	Object class	string	None.
Status	Status - new, pending, completed, failed, error. Setting the status to new will relaunch the process	string	None.
Detail	Details of failure or error	string	None.
ProduitId	Product id	integer	None.
Period	Period to renew	integer	None.
TotalTtc	Total ttc of the renewal	decimal number	None.
BillingHandle	Handle of the billing contact	string	None.
ProductName	Product name	string	None.
VerifyAccount	Flag to indicate if the account should be verified for this renewal	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "TransactionId": "sample string 2",
  "ObjectHandle": "sample string 3",
  "Class": "sample string 4",
  "Status": "sample string 5",
  "Detail": "sample string 6",
  "ProduitId": 7,
  "Period": 8,
  "TotalTtc": 1.0,
  "BillingHandle": "sample string 9",
  "ProductName": "sample string 10",
  "VerifyAccount": true
}

application/xml, text/xml

Sample:

<AutoRenew xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.AutoRenew">
  <BillingHandle>sample string 9</BillingHandle>
  <Class>sample string 4</Class>
  <Detail>sample string 6</Detail>
  <Id>1</Id>
  <ObjectHandle>sample string 3</ObjectHandle>
  <Period>8</Period>
  <ProductName>sample string 10</ProductName>
  <ProduitId>7</ProduitId>
  <Status>sample string 5</Status>
  <TotalTtc>1</TotalTtc>
  <TransactionId>sample string 2</TransactionId>
  <VerifyAccount>true</VerifyAccount>
</AutoRenew>