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
GET /policy/{tenantLocator}/autoRenewals/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:AutoRenewalResponse
Security Group:auto-renewals  Permission:read
AutoRenewalResponse
¶requiredlocator locatorpolicyLocator locatortermLocator locatorautoRenewalState Enum active | discarded | doNotRenew | issued | error | terminated | invalidatedrenewalTransactionType stringoptionalrenewalTransactionLocator locator?newTermDuration int?renewalTransactionAcceptedTime datetime?renewalTransactionAcceptTime datetime?renewalTransactionCreatedTime datetime?renewalTransactionCreateTime datetime?renewalTransactionIssuedTime datetime?renewalTransactionIssueTime datetime?validationResult ValidationResult?
Create
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
¶requiredpolicyLocator locatortermLocator locatorrenewalTransactionCreateTime datetimeoptionalrenewalTransactionLocator locator?autoRenewalState Enum? active | discarded | doNotRenew | issued | error | terminated | invalidatednewTermDuration int?renewalTransactionAcceptTime datetime?renewalTransactionIssueTime datetime?renewalTransactionType string?
Update
PATCH /policy/{tenantLocator}/autoRenewals/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:AutoRenewalUpdateRequest
Response:AutoRenewalResponse
Security Group:auto-renewals  Permission:write
AutoRenewalUpdateRequest
¶optionalrenewalTransactionLocator locator?newTermDuration int?renewalTransactionAcceptTime datetime?renewalTransactionCreateTime datetime?renewalTransactionIssueTime datetime?renewalTransactionType string?
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 | locator | required |
Request:AutoRenewalPutRequest
Response:AutoRenewalResponse
Security Group:auto-renewals  Permission:write
AutoRenewalPutRequest
¶requiredrenewalTransactionCreateTime datetimeoptionalrenewalTransactionLocator locator?newTermDuration int?renewalTransactionAcceptTime datetime?renewalTransactionIssueTime datetime?renewalTransactionType string?
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 | locator | required |
Response:AutoRenewalResponse
Security Group:auto-renewals  Permission:write
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 | locator | required |
Response:AutoRenewalResponse
Security Group:auto-renewals  Permission:write
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 | locator | required |
Response:AutoRenewalResponse
Security Group:auto-renewals  Permission:write
Plan Updates
PATCH /policy/{tenantLocator}/policies/{locator}/autoRenewalPlan
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:AutoRenewalPlanUpdateRequest
Response:PolicyResponse
Security Group:policies  Permission:write
PATCH /policy/{tenantLocator}/quotes/{locator}/autoRenewalPlan
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:AutoRenewalPlanUpdateRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
AutoRenewalPlanUpdateRequest
¶requiredautoRenewalPlanName string