Moratoriums API (Beta)

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

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

Create a Moratorium

Create a MoratoriumdeployMoratoriums

POST/config/{tenantLocator}/moratoriums

Parameters

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

Request:ConfigurationRef

Response:TenantDeploymentResult

Security Group:moratoriums

Permission:

deploy

Fetch

Fetch Existing Moratoriums

Fetch Existing MoratoriumsfetchMoratoriums

GET/config/{tenantLocator}/moratoriums

Parameters

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

Response:map<string, MoratoriumRef>

Security Group:moratoriums

Permissions:

deploy,fetch

Get a Policy's Moratorium Status

Get a Policy's Moratorium StatusgetPolicyMoratoriumsStatuses

GET/policy/{tenantLocator}/policies/{locator}/moratoriums

Parameters

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

Response:MoratoriumStatusesResponse

Security Group:policies

Permission:

moratoriums

Get a Quote's Moratorium Status

Get a Quote's Moratorium StatusgetQuoteMoratoriumsStatuses

GET/policy/{tenantLocator}/quotes/{locator}/moratoriums

Parameters

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

Response:MoratoriumStatusesResponse

Security Group:quotes

Permission:

moratoriums

Make Applicability Election

Add Policy Moratorium Elections

Add Policy Moratorium ElectionsaddPolicyMoratoriumElections

PUT/policy/{tenantLocator}/policies/{locator}/moratoriums/elections

Parameters

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

Request:MoratoriumElectionRequest[]

Response:PolicyResponse

Security Group:policies

Permission:

moratoriums

Delete Applicability Election

Delete Policy Moratorium Elections

Delete Policy Moratorium ElectionsdeletePolicyMoratoriumElections

DELETE/policy/{tenantLocator}/policies/{locator}/moratoriums/elections

Parameters

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

Request:string[]

Response:PolicyResponse

Security Group:policies

Permission:

moratoriums

MoratoriumStatusesResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`moratoriums`	`map<string, MoratoriumStatus>`

MoratoriumStatus

Required properties

Property	Type	Description
`applicable`	`boolean`
`applicationMode`	`Enum optIn \| optOut \| mandatory`
`eligible`	`boolean`
`inScope`	`boolean`

MoratoriumElectionRequest

Required properties

Property	Type	Description
`moratoriumName`	`string`
`election`	`Enum optIn \| optOut`

MoratoriumRef

Required properties

Property	Type	Description
`effectiveTime`	`datetime`
`applicationMode`	`Enum optIn \| optOut \| mandatory`	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 properties

Property	Type	Description
`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 properties

Property	Type	Description
`criteriaValues`	`map<string, string[]>`
`productsRules`	`map<string, MoratoriumProductRuleRef>`

MoratoriumProductRuleRef

Required properties

Property	Type	Description
`operator`	`Enum AND \| OR`
`product`	`string`
`rules`	`MoratoriumRuleRef[]`

Optional properties

Property	Type	Description
`displayName`	`string?`

MoratoriumRuleRef

Required properties

Property	Type	Description
`criteriaKey`	`string`
`notIn`	`boolean`
`path`	`string`

PolicyHoldScopeRef

Required properties

Property	Type	Description
`allowStaticData`	`boolean`
`transactionCategory`	`Enum[] issuance \| change \| renewal \| cancellation \| reinstatement \| reversal \| aggregate`
`transactionType`	`string[]`

Optional properties

Property	Type	Description
`displayName`	`string?`

BillingHoldScopeRef

Required properties

Property	Type	Description
`autopayHold`	`boolean`
`deferredInvoiceDueOffsetDays`	`number`
`policyDelinquencyHold`	`boolean`
`policyInvoicingHold`	`boolean`

Optional properties

Property	Type	Description
`displayName`	`string?`

Moratoriums API (Beta)

Create

Create a Moratorium

Fetch

Fetch Existing Moratoriums

Get a Policy's Moratorium Status

Get a Quote's Moratorium Status

Make Applicability Election

Add Policy Moratorium Elections

Delete Applicability Election

Delete Policy Moratorium Elections

See Also

On this page