Create a sub account

POST /api/v1/plans/{plan_uuid}/sub-accounts

Personal access token & O auth2

Path parameters

plan_uuid string Required

application/json

Body Required

name string Required

Descriptive name of the sub account
policy_number string

Sub account policy number
proposal_reference string

Sub account proposal number

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  UUID of the sub account
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was created.
- name string
  
  Descriptive name of the sub account
- policy_number string
  
  Provider reference of the sub account
- latest_valuation object
  
  The latest valuation of the sub account
  
  Hide latest_valuation attributes Show latest_valuation attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  valued_at string
  
  value object
  
  Hide value attributes Show value attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  sub_account string
- is_main_account boolean
  
  Denotes if the sub account a main account of the plan
- active_portfolio object
  
  The active portfolio of the sub account
  
  Hide active_portfolio attributes Show active_portfolio attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  is_proposed boolean
  
  proposed_at string
  
  name string
- statistics object
  
  The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
  
  Hide statistics attribute Show statistics attribute object
  
  recent_growth integer

POST /api/v1/plans/{plan_uuid}/sub-accounts

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-accounts' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"Johns ISA","policy_number":"AVF-4355432","proposal_reference":"BtMWiy0JwHtogU4"}'

Request examples

{
  "name": "Johns ISA",
  "policy_number": "AVF-4355432",
  "proposal_reference": "BtMWiy0JwHtogU4"
}

Response examples (200)

{
  "name": "John's ISA",
  "uuid": "2f6869e4-f59e-4cd9-acab-66d8af18acf1",
  "created_at": "2025-08-07T13:41:43+01:00",
  "statistics": {
    "recent_growth": 100
  },
  "updated_at": "2025-08-07T13:41:43+01:00",
  "policy_number": "AVI-4837",
  "is_main_account": false,
  "active_portfolio": {
    "name": "Risky Portfolio",
    "uuid": "eecb68eb-7879-4ca6-9110-9b949e391563",
    "created_at": "2025-08-07T13:41:43+01:00",
    "updated_at": "2025-08-07T13:41:43+01:00",
    "is_proposed": true,
    "proposed_at": "2025-08-07T00:00:00+01:00"
  },
  "latest_valuation": {
    "uuid": "a57b971f-76ca-4187-bce1-e08b22625ce7",
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "valued_at": "2025-08-07T13:41:43+01:00",
    "created_at": "2025-08-07T13:41:43+01:00",
    "updated_at": "2025-08-07T13:41:43+01:00",
    "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
  }
}