Get a beneficiary of a plan

GET /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
Personal access token & OAuth2

Path parameters

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 \
 --request GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/beneficiary/uuid \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "name": "Beneficiary name",
  "uuid": "2a049825-fcab-4994-9960-2432d4a6ae95",
  "cover": {
    "uuid": "a67845e1-4533-43a8-a2c5-b9834d1c7f97",
    "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-02-20T10:13:04+00:00",
    "indexation": 1.4,
    "updated_at": "2025-02-20T10:13:04+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-02-20T10:13:04+00:00",
  "percentage": 50,
  "updated_at": "2025-02-20T10:13:04+00:00"
}