Renewal Management and Auto-Renewal API

Endpoint Index

Action	Endpoint
Fetch Auto Renewal	GET /policy/{tenantLocator}/autoRenewals/{locator}
Create Auto Renewal	POST /policy/{tenantLocator}/autoRenewals
Update Auto Renewal	PATCH /policy/{tenantLocator}/autoRenewals/{locator}
Put Auto Renewal	PUT /policy/{tenantLocator}/autoRenewals/{locator}
Mark Policy for Do Not Renew	PATCH /policy/{tenantLocator}/autoRenewals/{locator}/doNotRenew
Reactivate Auto Renewal	PATCH /policy/{tenantLocator}/autoRenewals/{locator}/activate
Discard Auto Renewal	PATCH /policy/{tenantLocator}/autoRenewals/{locator}/discard
Update Policy Auto Renewal Plan	PATCH /policy/{tenantLocator}/policies/{locator}/autoRenewalPlan
Update Quote Auto Renewal Plan	PATCH /policy/{tenantLocator}/quotes/{locator}/autoRenewalPlan

Fetch

Fetch Auto Renewal

fetchAutoRenewal

GET /policy/{tenantLocator}/autoRenewals/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:AutoRenewalResponse
Security Group:auto-renewals   Permission:read

AutoRenewalResponse

required
locator string
policyLocator string
termLocator string
autoRenewalState Enum active | discarded | doNotRenew | issued | error | terminated | invalidated
renewalTransactionType string

optional
renewalTransactionLocator string?
newTermDuration int?
renewalTransactionAcceptedTime datetime?
renewalTransactionAcceptTime datetime?
renewalTransactionCreatedTime datetime?
renewalTransactionCreateTime datetime?
renewalTransactionIssuedTime datetime?
renewalTransactionIssueTime datetime?
validationResult ValidationResult?

Create

Create Auto Renewal

createAutoRenewal

POST /policy/{tenantLocator}/autoRenewals

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:AutoRenewalCreateRequest
Response:AutoRenewalResponse
Security Group:auto-renewals   Permission:write

AutoRenewalCreateRequest

required
policyLocator string
termLocator string
renewalTransactionCreateTime datetime

optional
renewalTransactionLocator string?
autoRenewalState Enum? active | discarded | doNotRenew | issued | error | terminated | invalidated
newTermDuration int?
renewalTransactionAcceptTime datetime?
renewalTransactionIssueTime datetime?
renewalTransactionType string?

Update

Update Auto Renewal

updateAutoRenewal

PATCH /policy/{tenantLocator}/autoRenewals/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:AutoRenewalUpdateRequest
Response:AutoRenewalResponse
Security Group:auto-renewals   Permission:write

AutoRenewalUpdateRequest

optional
renewalTransactionLocator string?
newTermDuration int?
renewalTransactionAcceptTime datetime?
renewalTransactionCreateTime datetime?
renewalTransactionIssueTime datetime?
renewalTransactionType string?

Put Auto Renewal

putAutoRenewal

Creates or replaces *all* the specified data on the auto renewal, including null values.

PUT /policy/{tenantLocator}/autoRenewals/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:AutoRenewalPutRequest
Response:AutoRenewalResponse
Security Group:auto-renewals   Permission:write

AutoRenewalPutRequest

required
renewalTransactionCreateTime datetime

optional
renewalTransactionLocator string?
newTermDuration int?
renewalTransactionAcceptTime datetime?
renewalTransactionIssueTime datetime?
renewalTransactionType string?

Mark Policy for Do Not Renew

markPolicyForDoNotRenew

Prevents renewal of the policy, either with auto-renew or manually.

PATCH /policy/{tenantLocator}/autoRenewals/{locator}/doNotRenew

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:AutoRenewalResponse
Security Group:auto-renewals   Permission:write

Reactivate Auto Renewal

reactivateAutoRenewal

Restarts autorenewal when it has been previously put into doNotRenew, error, or terminated state.

PATCH /policy/{tenantLocator}/autoRenewals/{locator}/activate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:AutoRenewalResponse
Security Group:auto-renewals   Permission:write

Discard Auto Renewal

discardAutoRenewal

Discards and prevents auto renewal unless a new one is created.

PATCH /policy/{tenantLocator}/autoRenewals/{locator}/discard

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:AutoRenewalResponse
Security Group:auto-renewals   Permission:write

Plan Updates

Update Policy Auto Renewal Plan

updatePolicyAutoRenewalPlan

PATCH /policy/{tenantLocator}/policies/{locator}/autoRenewalPlan

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:AutoRenewalPlanUpdateRequest
Response:PolicyResponse
Security Group:policies   Permission:write

Update Quote Auto Renewal Plan

updateQuoteAutoRenewalPlan

PATCH /policy/{tenantLocator}/quotes/{locator}/autoRenewalPlan

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:AutoRenewalPlanUpdateRequest
Response:QuoteResponse
Security Group:quotes   Permission:write

AutoRenewalPlanUpdateRequest

required
autoRenewalPlanName string

See Also

• Renewal Management and Auto-Renewal Feature Guide

• Configuration