Renewal Management and Auto-Renewal API

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

Fetch Auto RenewalfetchAutoRenewal

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:AutoRenewalExtendedResponse

Security Group:auto-renewals

Permission:

read

AutoRenewalResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`policyLocator`	`ulid`
`termLocator`	`ulid`
`autoRenewalState`	`Enum active \| discarded \| doNotRenew \| issued \| error \| terminated \| invalidated`
`renewalTransactionType`	`string`

Optional properties

Property	Type	Description
`renewalTransactionLocator`	`ulid?`
`newTermDuration`	`integer?`
`renewalTransactionAcceptedTime`	`datetime?`
`renewalTransactionAcceptTime`	`datetime?`
`renewalTransactionCreatedTime`	`datetime?`
`renewalTransactionCreateTime`	`datetime?`
`renewalTransactionIssuedTime`	`datetime?`
`renewalTransactionIssueTime`	`datetime?`
`validationResult`	`ValidationResult?`

AutoRenewalExtendedResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`policyLocator`	`ulid`
`termLocator`	`ulid`
`autoRenewalState`	`Enum active \| discarded \| doNotRenew \| issued \| error \| terminated \| invalidated`
`renewalTransactionType`	`string`

Optional properties

Property	Type	Description
`renewalTransactionLocator`	`ulid?`
`newTermDuration`	`integer?`
`processingErrors`	`string?`
`renewalTransactionAcceptedTime`	`datetime?`
`renewalTransactionAcceptTime`	`datetime?`
`renewalTransactionCreatedTime`	`datetime?`
`renewalTransactionCreateTime`	`datetime?`
`renewalTransactionIssuedTime`	`datetime?`
`renewalTransactionIssueTime`	`datetime?`
`validationResult`	`ValidationResult?`

Create

Create Auto Renewal

Create Auto RenewalcreateAutoRenewal

POST/policy/{tenantLocator}/autoRenewals

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:AutoRenewalCreateRequest

Response:AutoRenewalResponse

Security Group:auto-renewals

Permission:

write

AutoRenewalCreateRequest

Required properties

Property	Type	Description
`policyLocator`	`ulid`
`termLocator`	`ulid`
`renewalTransactionCreateTime`	`datetime`

Optional properties

Property	Type	Description
`renewalTransactionLocator`	`ulid?`
`autoRenewalState`	`Enum? active \| discarded \| doNotRenew \| issued \| error \| terminated \| invalidated`
`newTermDuration`	`integer?`
`renewalTransactionAcceptTime`	`datetime?`
`renewalTransactionIssueTime`	`datetime?`
`renewalTransactionType`	`string?`

Update

Update Auto Renewal

Update Auto RenewalupdateAutoRenewal

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:AutoRenewalUpdateRequest

Response:AutoRenewalResponse

Security Group:auto-renewals

Permission:

write

AutoRenewalUpdateRequest

Properties

Property	Type	Description
`renewalTransactionLocator`	`ulid?`
`newTermDuration`	`integer?`
`renewalTransactionAcceptTime`	`datetime?`
`renewalTransactionCreateTime`	`datetime?`
`renewalTransactionIssueTime`	`datetime?`
`renewalTransactionType`	`string?`

Put Auto Renewal

Put Auto RenewalputAutoRenewal

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

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:AutoRenewalPutRequest

Response:AutoRenewalResponse

Security Group:auto-renewals

Permission:

write

AutoRenewalPutRequest

Required properties

Property	Type	Description
`renewalTransactionCreateTime`	`datetime`

Optional properties

Property	Type	Description
`renewalTransactionLocator`	`ulid?`
`newTermDuration`	`integer?`
`renewalTransactionAcceptTime`	`datetime?`
`renewalTransactionIssueTime`	`datetime?`
`renewalTransactionType`	`string?`

Mark Policy For Do Not Renew

Mark Policy For Do Not RenewmarkPolicyForDoNotRenew

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

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:AutoRenewalResponse

Security Group:auto-renewals

Permission:

write

Reactivate Auto Renewal

Reactivate Auto RenewalreactivateAutoRenewal

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

Restarts auto-renewal when it has been previously put into the doNotRenew or error state. Autorenewals in the terminated, discarded, issued, or invalidated state cannot be reactivated.

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:AutoRenewalResponse

Security Group:auto-renewals

Permission:

write

Discard Auto Renewal

Discard Auto RenewaldiscardAutoRenewal

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

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:AutoRenewalResponse

Security Group:auto-renewals

Permission:

write

Plan Updates

Update Policy Auto Renewal Plan

Update Policy Auto Renewal PlanupdatePolicyAutoRenewalPlan

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:AutoRenewalPlanUpdateRequest

Response:PolicyResponse

Security Group:policies

Permission:

write

Update Quote Auto Renewal Plan

Update Quote Auto Renewal PlanupdateQuoteAutoRenewalPlan

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:AutoRenewalPlanUpdateRequest

Response:QuoteResponse

Security Group:quotes

Permission:

write

AutoRenewalPlanUpdateRequest

Required properties

Property	Type	Description
`autoRenewalPlanName`	`string`

Renewal Management and Auto-Renewal API

Fetch

Fetch Auto Renewal

Create

Create Auto Renewal

Update

Update Auto Renewal

Put Auto Renewal

Mark Policy For Do Not Renew

Reactivate Auto Renewal

Discard Auto Renewal

Plan Updates

Update Policy Auto Renewal Plan

Update Quote Auto Renewal Plan

See Also

On this page

Renewal Management and Auto-Renewal API

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

On this page