Get a beneficiary of a plan

GET /api/v1/plans/{plan_uuid}/beneficiary/{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.
- name string
  
  Beneficiary name.
- percentage integer
  
  Beneficiary percentage.
- cover object
  
  Cover this beneficiary is for.
  
  Additional properties are allowed.

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

curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/beneficiary/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)

{
  "name": "Beneficiary name",
  "uuid": "ceb29037-cf32-4ad6-a69f-516eb75cc775",
  "cover": {
    "uuid": "c10a787f-f980-4f81-9fb3-2eca0a506f13",
    "client": "App\\Http\\Resources\\AccountResource",
    "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": "2025-01-17T11:18:31+00:00",
    "indexation": 1.4,
    "updated_at": "2025-01-17T11:18:31+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"
  },
  "created_at": "2025-01-17T11:18:31+00:00",
  "percentage": 50,
  "updated_at": "2025-01-17T11:18:31+00:00"
}