# Renewal Management and Auto-Renewal API



<EndpointIndex
  names={[
  	'fetchAutoRenewal',
  	'createAutoRenewal',
  	'updateAutoRenewal',
  	'putAutoRenewal',
  	'markPolicyForDoNotRenew',
  	'reactivateAutoRenewal',
  	'discardAutoRenewal',
  	'updatePolicyAutoRenewalPlan',
  	'updateQuoteAutoRenewalPlan',
  ]}
/>

Fetch [#fetch]

Fetch Auto Renewal [#fetch-auto-renewal]

<ApiEndpoint name="fetchAutoRenewal" />

<ApiSchema name="AutoRenewalResponse" />

Create [#create]

Create Auto Renewal [#create-auto-renewal]

<ApiEndpoint name="createAutoRenewal" />

<ApiSchema name="AutoRenewalCreateRequest" />

Update [#update]

Update Auto Renewal [#update-auto-renewal]

<ApiEndpoint name="updateAutoRenewal" />

<ApiSchema name="AutoRenewalUpdateRequest" />

Put Auto Renewal [#put-auto-renewal]

<ApiEndpoint name="putAutoRenewal" />

<ApiSchema name="AutoRenewalPutRequest" />

Mark Policy For Do Not Renew [#mark-policy-for-do-not-renew]

<ApiEndpoint name="markPolicyForDoNotRenew" />

Reactivate Auto Renewal [#reactivate-auto-renewal]

<ApiEndpoint name="reactivateAutoRenewal" />

Discard Auto Renewal [#discard-auto-renewal]

<ApiEndpoint name="discardAutoRenewal" />

Plan Updates [#plan-updates]

Update Policy Auto Renewal Plan [#update-policy-auto-renewal-plan]

<ApiEndpoint name="updatePolicyAutoRenewalPlan" />

Update Quote Auto Renewal Plan [#update-quote-auto-renewal-plan]

<ApiEndpoint name="updateQuoteAutoRenewalPlan" />

<ApiSchema name="AutoRenewalPlanUpdateRequest" />

See Also [#see-also]

* [Renewal Management and Auto-Renewal Feature Guide](/features/policy-management/renewal-management)
* <ApiLink name="AutoRenewalPlanRef">
    Configuration
  </ApiLink>


## API Reference

GET /policy/{tenantLocator}/autoRenewals/{locator} — fetchAutoRenewal
Tags: auto-renewals-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 AutoRenewalResponse — OK

POST /policy/{tenantLocator}/autoRenewals — createAutoRenewal
Tags: auto-renewals-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
Request body (AutoRenewalCreateRequest):
Responses:
  200 AutoRenewalResponse — OK

PATCH /policy/{tenantLocator}/autoRenewals/{locator} — updateAutoRenewal
Tags: auto-renewals-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Request body (AutoRenewalUpdateRequest):
Responses:
  200 AutoRenewalResponse — OK

PUT /policy/{tenantLocator}/autoRenewals/{locator} — putAutoRenewal
Creates or replaces *all* the specified data on the auto renewal, including null values.
Tags: auto-renewals-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Request body (AutoRenewalPutRequest):
Responses:
  200 AutoRenewalResponse — OK

PATCH /policy/{tenantLocator}/autoRenewals/{locator}/doNotRenew — markPolicyForDoNotRenew
Prevents renewal of the policy, either with auto-renew or manually.
Tags: auto-renewals-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 AutoRenewalResponse — OK

PATCH /policy/{tenantLocator}/autoRenewals/{locator}/activate — reactivateAutoRenewal
Restarts autorenewal when it has been previously put into doNotRenew, error, or terminated state.
Tags: auto-renewals-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 AutoRenewalResponse — OK

PATCH /policy/{tenantLocator}/autoRenewals/{locator}/discard — discardAutoRenewal
Discards and prevents auto renewal unless a new one is created.
Tags: auto-renewals-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 AutoRenewalResponse — OK

PATCH /policy/{tenantLocator}/policies/{locator}/autoRenewalPlan — updatePolicyAutoRenewalPlan
Tags: policies-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Request body (AutoRenewalPlanUpdateRequest):
Responses:
  200 PolicyResponse — OK

PATCH /policy/{tenantLocator}/quotes/{locator}/autoRenewalPlan — updateQuoteAutoRenewalPlan
Tags: quotes-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Request body (AutoRenewalPlanUpdateRequest):
Responses:
  200 QuoteResponse — OK

AutoRenewalResponse
Properties:
  locator (ulid, required)
  autoRenewalState (Enum active | discarded | doNotRenew | issued | error | terminated | invalidated, required)
  policyLocator (ulid, required)
  termLocator (ulid, required)
  renewalTransactionType (string, required)
  renewalTransactionLocator (ulid)
  renewalTransactionCreateTime (datetime)
  renewalTransactionCreatedTime (datetime)
  renewalTransactionAcceptTime (datetime)
  renewalTransactionAcceptedTime (datetime)
  renewalTransactionIssueTime (datetime)
  renewalTransactionIssuedTime (datetime)
  newTermDuration (integer)
  validationResult (ValidationResult)

AutoRenewalCreateRequest
Properties:
  termLocator (ulid, required)
  policyLocator (ulid, required)
  autoRenewalState (Enum active | discarded | doNotRenew | issued | error | terminated | invalidated)
  renewalTransactionType (string)
  newTermDuration (integer)
  renewalTransactionCreateTime (datetime, required)
  renewalTransactionAcceptTime (datetime)
  renewalTransactionIssueTime (datetime)
  renewalTransactionLocator (ulid)

AutoRenewalUpdateRequest
Properties:
  renewalTransactionType (string)
  newTermDuration (integer)
  renewalTransactionCreateTime (datetime)
  renewalTransactionAcceptTime (datetime)
  renewalTransactionIssueTime (datetime)
  renewalTransactionLocator (ulid)

AutoRenewalPutRequest
Properties:
  renewalTransactionType (string)
  newTermDuration (integer)
  renewalTransactionCreateTime (datetime, required)
  renewalTransactionAcceptTime (datetime)
  renewalTransactionIssueTime (datetime)
  renewalTransactionLocator (ulid)

AutoRenewalPlanUpdateRequest
Properties:
  autoRenewalPlanName (string, required)