Renewal Management and Auto-Renewal API

Endpoint Index

ActionEndpoint
Fetch Auto RenewalGET /policy/{tenantLocator}/autoRenewals/{locator}
Create Auto RenewalPOST /policy/{tenantLocator}/autoRenewals
Update Auto RenewalPATCH /policy/{tenantLocator}/autoRenewals/{locator}
Put Auto RenewalPUT /policy/{tenantLocator}/autoRenewals/{locator}
Mark Policy for Do Not RenewPATCH /policy/{tenantLocator}/autoRenewals/{locator}/doNotRenew
Reactivate Auto RenewalPATCH /policy/{tenantLocator}/autoRenewals/{locator}/activate
Discard Auto RenewalPATCH /policy/{tenantLocator}/autoRenewals/{locator}/discard
Update Policy Auto Renewal PlanPATCH /policy/{tenantLocator}/policies/{locator}/autoRenewalPlan
Update Quote Auto Renewal PlanPATCH /policy/{tenantLocator}/quotes/{locator}/autoRenewalPlan

Fetch

Fetch Auto Renewal
fetchAutoRenewal
GET /policy/{tenantLocator}/autoRenewals/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:auto-renewals   Permission:read
AutoRenewalResponse
required
locator locator
policyLocator locator
termLocator locator
autoRenewalState Enum active | discarded | doNotRenew | issued | error | terminated | invalidated
renewalTransactionType string

optional
renewalTransactionLocator locator?
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
AutoRenewalCreateRequest
required
policyLocator locator
termLocator locator
renewalTransactionCreateTime datetime

optional
renewalTransactionLocator locator?
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}
AutoRenewalUpdateRequest
optional
renewalTransactionLocator locator?
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:auto-renewals   Permission:write
AutoRenewalPutRequest
required
renewalTransactionCreateTime datetime

optional
renewalTransactionLocator locator?
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:auto-renewals   Permission:write

Plan Updates

Update Policy Auto Renewal Plan
updatePolicyAutoRenewalPlan
PATCH /policy/{tenantLocator}/policies/{locator}/autoRenewalPlan
Update Quote Auto Renewal Plan
updateQuoteAutoRenewalPlan
PATCH /policy/{tenantLocator}/quotes/{locator}/autoRenewalPlan
AutoRenewalPlanUpdateRequest
required
autoRenewalPlanName string

See Also