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
Action | Endpoint |
---|---|
Create a Moratorium | POST /config/{tenantLocator}/moratoriums |
Fetch Existing Moratoriums | GET /config/{tenantLocator}/moratoriums |
Get a Policy's Moratorium Status | GET /policy/{tenantLocator}/policies/{locator}/moratoriums |
Get a Quote's Moratorium Status | GET /policy/{tenantLocator}/quotes/{locator}/moratoriums |
Add Policy Moratorium Elections | PUT /policy/{tenantLocator}/policies/{locator}/moratoriums/elections |
Delete Policy Moratorium Elections | DELETE /policy/{tenantLocator}/policies/{locator}/moratoriums/elections |
Create
POST /config/{tenantLocator}/moratoriums
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:ConfigurationRef
Response:TenantDeploymentResult
Security Group:moratoriums  Permission:deploy
Fetch
GET /config/{tenantLocator}/moratoriums
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Response:map<string,MoratoriumRef>
Security Group:moratoriums  Permissions:deploy,fetch
GET /policy/{tenantLocator}/policies/{locator}/moratoriums
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:MoratoriumStatusesResponse
Security Group:policies  Permission:moratoriums
GET /policy/{tenantLocator}/quotes/{locator}/moratoriums
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:MoratoriumStatusesResponse
Security Group:quotes  Permission:moratoriums
Make Applicability Election
PUT /policy/{tenantLocator}/policies/{locator}/moratoriums/elections
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:MoratoriumElectionRequest[]
Response:PolicyResponse
Security Group:policies  Permission:moratoriums
Delete Applicability Election
DELETE /policy/{tenantLocator}/policies/{locator}/moratoriums/elections
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:string[]
Response:PolicyResponse
Security Group:policies  Permission:moratoriums
MoratoriumStatusesResponse
¶requiredlocator stringmoratoriums map<string,MoratoriumStatus>
MoratoriumStatus
¶requiredapplicable booleanapplicationMode Enum mandatory | optIn | optOuteligible booleaninScope boolean
MoratoriumElectionRequest
¶requiredmoratoriumName stringelection Enum optIn | optOut
MoratoriumRef
¶requiredeffectiveTime datetimeapplicationMode 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 BillingHoldScopeRefpolicyHoldScope 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 stringoptionaldisplayName 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 effectTime are affected.
MoratoriumPolicyMatchCriteriaRef
¶requiredcriteriaValues map<string,string[]>productsRules map<string,MoratoriumProductRuleRef>
MoratoriumProductRuleRef
¶requireddisplayName stringoperator Enum AND | ORproduct stringrules MoratoriumRuleRef[]
MoratoriumRuleRef
¶requiredcriteriaKey stringnotIn booleanpath string
PolicyHoldScopeRef
¶requireddisplayName stringallowStaticData booleantransactionCategory Enum[] issuance | change | renewal | cancellation | reinstatement | reversal | aggregatetransactionType string[]
BillingHoldScopeRef
¶requireddisplayName stringautopayHold booleandeferredInvoiceDueOffsetDays numberpolicyDelinquencyHold booleanpolicyInvoicingHold boolean