Get cover of a plan

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

Path parameters

Responses

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": "8dd3bc9d-82d3-423e-a374-2a2636eb9f6b",
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "5246b2c6-41f9-42e5-9ead-46fae6f572e3",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:03+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:03+00: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-11-20T13:24:03+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:03+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:03+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:03+00: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-11-20T13:24:03+00:00",
  "indexation": 1.4,
  "updated_at": "2024-11-20T13:24:03+00: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"
}