Delete a policy

View as Markdown
DELETE /api/v1/policies/{policy}

Permanently deletes a policy. Deleting a policy immediately cancels the insurance coverage for the contractor. Any assignments with an effective date after the policy deletion date will also be cancelled.

Path parameters

  • policy string Required

    The ID of the desired policy (e.g., pl_WzFRszJhoY).

Responses

  • 200 application/json

    Returns an object with a deleted parameter on success. If the policy ID does not exist, this call returns an error.

    Hide response attributes Show response attributes object
    • deleted boolean
    • deleted_at integer

      Unix timestamp (seconds since epoch) of when the policy was deleted.

    • id string

      The policy ID.

    • object string

      Default value is policy.

DELETE /api/v1/policies/{policy}
curl \
 --request DELETE 'https://api.1099policy.com/api/v1/policies/pl_WzFRszJhoY'
Response examples (200)
{
  "id": "pl_WzFRszJhoY",
  "object": "policy",
  "deleted": true,
  "deleted_at": 1640995200
}