Cancellations API

Endpoint Index

Action	Endpoint
Fetch a grace period	GET /gracePeriod/{gracePeriodLocator}
Update a grace period	PATCH /gracePeriod/{gracePeriodLocator}
Create a cancellation	POST /policies/{locator}/cancellations
Fetch a cancellation	GET /cancellations/{locator}
Update a cancellation	PATCH /cancellations/{locator}
Issue a cancellation	PATCH /cancellations/{locator}/issue
Rescind a cancellation	PATCH /cancellations/{locator}/rescind
Fetch Pricing for a cancellation	GET /cancellations/{locator}/price
Fetch cancellations for a policy	GET /policies/{locator}/cancellations
Fetch grace periods for a policy	GET /policy/{policyLocator}/gracePeriods

Grace Periods

Fetch a grace period¶

GET /gracePeriod/{gracePeriodLocator}

Request:

Name	Position	Type	Required
gracePeriodLocator	path	string	required

Response: GracePeriodResponse

GracePeriodResponse¶

required
locator string
policyholderLocator string
policyLocator string
productLocator string
startTimestamp timestamp
endTimestamp timestamp
invoiceLocator string
policyId string (deprecated)

optional
cancellationLocator string
cancelEffectiveTimestamp timestamp
settledTimestamp timestamp
document PolicyDocumentResponse

Update a grace period¶

PATCH /gracePeriod/{gracePeriodLocator}

Request:

Name	Position	Type	Required
gracePeriodLocator	path	string	required
gracePeriodUpdateRequest	body	GracePeriodUpdateRequest	required

Response: GracePeriodResponse

GracePeriodUpdateRequest¶

optional
endTimestamp timestamp
cancelEffectiveTimestamp timestamp
resetCancelEffectiveTimestamp boolean

Important

Updating a grace period’s end timestamp controls when the policy will lapse if invoices remain past due. If set to the current time, the policy will lapse immediately.

Cancellation

Create a cancellation¶

POST /policies/{locator}/cancellations

Request:

Name	Position	Type	Required
locator	path	string	required
req	body	CancellationRequest	required

Response: CancellationResponse

CancellationRequest¶

required
name string
effectiveTimestamp timestamp

optional
cancellationCategory string
cancellationComments string
issue boolean
conflictHandling string block | invalidate

Fetch a cancellation¶

GET /cancellations/{locator}

Request:

Name	Position	Type	Required
locator	path	string	required

Response: CancellationResponse

Update a cancellation¶

PATCH /cancellations/{locator}

Request:

Name	Position	Type	Required
locator	path	string	required
req	body	CancellationUpdateRequest	required

Response: CancellationResponse

CancellationUpdateRequest¶

optional
name string
effectiveTimestamp timestamp
cancellationCategory string
cancellationComments string
conflictHandling string block | invalidate

Issue a cancellation¶

PATCH /cancellations/{locator}/issue

Request:

Name	Position	Type	Required
locator	path	string	required

Response: CancellationResponse

If there is an active grace period with cancellation effective time later than the effective time of an issued cancellation, it will be settled.

Rescind a cancellation¶

PATCH /cancellations/{locator}/rescind

Request:

Name	Position	Type	Required
locator	path	string	required

Response: CancellationResponse

CancellationResponse¶

required
locator string
name string
title string
policyLocator string
state string draft | issued | rescinded | reinstated
createdTimestamp timestamp
effectiveTimestamp timestamp
documents [PolicyDocumentResponse]
policyModificationLocator string
conflictHandling string block | invalidate

optional
issuedTimestamp timestamp
cancellationCategory string
cancellationComments string
invoiceLocator string
price PolicyPriceChangeResponse
reinstatement ReinstatementResponse

Fetch Pricing for a cancellation¶

GET /cancellations/{locator}/price

Request:

Name	Position	Type	Required
locator	path	string	required

Response: PolicyPriceChangeResponse

Fetch cancellations for a policy¶

GET /policies/{locator}/cancellations

Request:

Name	Position	Type	Required
locator	path	string	required

Response: [CancellationResponse]

If there are no cancellations for the policy, an empty array will be returned.

Fetch grace periods for a policy¶

GET /policy/{policyLocator}/gracePeriods

Request:

Name	Position	Type	Required
policyLocator	path	string	required

Response: [GracePeriodResponse]

After a grace period expires, a cancellation named lapse will be created.

Legacy Lapsing and Reinstatement

See the Legacy Grace, Lapse & Reinstatement API guide for details about the previous version of this functionality.