Moratoriums API (Beta)

Warning

This feature is currently in beta and may be subject to change. Before using it in production, please contact your Socotra representative.

Endpoint Index

ActionEndpoint
Create a MoratoriumPOST /config/{tenantLocator}/moratoriums
Fetch Existing MoratoriumsGET /config/{tenantLocator}/moratoriums
Get a Policy's Moratorium StatusGET /policy/{tenantLocator}/policies/{locator}/moratoriums
Get a Quote's Moratorium StatusGET /policy/{tenantLocator}/quotes/{locator}/moratoriums
Add Policy Moratorium ElectionsPUT /policy/{tenantLocator}/policies/{locator}/moratoriums/elections
Delete Policy Moratorium ElectionsDELETE /policy/{tenantLocator}/policies/{locator}/moratoriums/elections

Create

Create a Moratorium
deployMoratoriums
POST /config/{tenantLocator}/moratoriums

Fetch

Fetch Existing Moratoriums
fetchMoratoriums
GET /config/{tenantLocator}/moratoriums
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Response:map<string,MoratoriumRef>
    Security Group:moratoriums   Permissions:deploy,fetch
Get a Policy's Moratorium Status
getPolicyMoratoriumsStatuses
GET /policy/{tenantLocator}/policies/{locator}/moratoriums
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:MoratoriumStatusesResponse
    Security Group:policies   Permission:moratoriums
Get a Quote's Moratorium Status
getQuoteMoratoriumsStatuses
GET /policy/{tenantLocator}/quotes/{locator}/moratoriums
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:MoratoriumStatusesResponse
    Security Group:quotes   Permission:moratoriums

Make Applicability Election

Add Policy Moratorium Elections
addPolicyMoratoriumElections
PUT /policy/{tenantLocator}/policies/{locator}/moratoriums/elections
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Request:MoratoriumElectionRequest[]
    Response:PolicyResponse
    Security Group:policies   Permission:moratoriums

Delete Applicability Election

Delete Policy Moratorium Elections
deletePolicyMoratoriumElections
DELETE /policy/{tenantLocator}/policies/{locator}/moratoriums/elections
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Request:string[]
    Response:PolicyResponse
    Security Group:policies   Permission:moratoriums
MoratoriumStatusesResponse
required
locator string
moratoriums map<string,MoratoriumStatus>
MoratoriumStatus
required
applicable boolean
applicationMode Enum mandatory | optIn | optOut
eligible boolean
inScope boolean
MoratoriumElectionRequest
required
moratoriumName string
election Enum optIn | optOut
MoratoriumRef
required
effectiveTime datetime
applicationMode Enum mandatory | optIn | optOut
Indicates whether the moratorium applies to all eligible policies or whether there is an option to opt in or out.
billingHoldScope BillingHoldScopeRef
policyHoldScope PolicyHoldScopeRef
Must be at least one of either policyHoldScope or billingHoldScope.
policyMatchCriteria MoratoriumPolicyMatchCriteriaRef
The criteria used to identify which policies are eligible for the moratorium.
type string

optional
displayName string?
endTime datetime?
The time the moratorium ends. This can be set after creation and updated to earlier or later.
description string?
effectiveTimeWaived boolean?
Indicates whether eligible policies issued after the moratorium effectiveTime are affected.
MoratoriumPolicyMatchCriteriaRef
required
criteriaValues map<string,string[]>
productsRules map<string,MoratoriumProductRuleRef>
MoratoriumProductRuleRef
required
operator Enum AND | OR
product string
rules MoratoriumRuleRef[]

optional
displayName string?
MoratoriumRuleRef
required
criteriaKey string
notIn boolean
path string
PolicyHoldScopeRef
required
allowStaticData boolean
transactionCategory Enum[] issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
transactionType string[]

optional
displayName string?
BillingHoldScopeRef
required
autopayHold boolean
deferredInvoiceDueOffsetDays number
policyDelinquencyHold boolean
policyInvoicingHold boolean

optional
displayName string?

See Also