Get cover of a plan

GET /api/v1/plans/{plan_uuid}/cover/{uuid}

Headers

Path parameters

plan_uuid string Required
uuid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- cover_type string
  
  Cover type
- benefit_amount object
  
  Benefit amount
- benefit_frequency string
  
  Benefit frequency
- benefit_status string
  
  Benefit status
- excess object
  
  Excess
- indexation number
  
  Indexation percentage
- client object
  
  Client this cover is for

GET /api/v1/plans/{plan_uuid}/cover/{uuid}

curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/cover/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "uuid": "3a3730c8-7909-4715-9128-5ae24491990c",
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "cbfdc1be-b827-42e7-b35b-8badee183c4b",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:16+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:16+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:16+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:16+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:16+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:16+01:00"
  },
  "excess": {
    "amount": {
      "example": "10000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£100.00",
      "description": "Money amount formatted with currency"
    }
  },
  "cover_type": "critical_illness",
  "created_at": "2024-10-16T11:10:16+01:00",
  "indexation": 1.4,
  "updated_at": "2024-10-16T11:10:16+01:00",
  "benefit_amount": {
    "amount": {
      "example": "25000000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£250,000.00",
      "description": "Money amount formatted with currency"
    }
  },
  "benefit_status": "active",
  "benefit_frequency": "monthly"
}