# Get a plan

**GET /api/v1/plans/{uuid}**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)


### Path parameters
- **uuid** (string)

- **plan** (string)
  The UUID of the plan



## Responses
### 200


#### Body: application/json (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.
- **opened_at** (string)
  Timestamp of when the plan was originally opened
- **name** (string)
  Name of the plan
- **type** (string)
  Type of plan, this will indicate what to expect from the fields attribute
- **sub_type** (string)
  Plan sub type
- **abstract_type** (string)
  describes if the plan is an asset, protection or liability
- **policy_number** (string)
  The policy number on the main sub account of the plan
- **proposal_reference** (string)
  The proposal reference on the main sub account of the plan
- **status** (string)
  Plan status
- **inactive_at** (string)
  Timestamp of when the plan became inactive
- **inactive_reason** (string)
  Reason for inactivity
- **agency_in_your_name** (boolean)
  Denotes if plan has agency in your name
- **agency_in_your_name_from** (string)
  Date the agency was in your name from
- **originally_sold_by_firm** (boolean)
  Denotes if the plan was originally sold by your firm
- **under_advice** (boolean)
  Denotes if plan is under advice
- **visible_on_client_portal** (boolean)
  Denotes if this plan is visible to clients on the client portal
- **include_in_client_valuation** (boolean)
  Denotes if this plan should be included in the client valuation
- **show_on_joint** (boolean)
  Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of
- **shown_on_circles** (boolean)
  Determines if plan should be shown on a circle
- **review_date** (string)
  Review date
- **on_panel** (boolean)
  On panel
- **is_group_scheme** (boolean)
  Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes.
- **is_sub_group_scheme** (boolean)
  Denotes if the plan is a sub-scheme of a group scheme.
- **is_group_scheme_member** (boolean)
  Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.
- **advice_area** (string)
  The advice area of the plan based on the plan's sub type.
- **main_account** (object)
  Plans main account
- **sub_accounts** (array[object])
  Plans sub accounts
- **provider** (object)
  The plan's provider
- **covers** (array[object])
  Covers of the plan
- **claims** (array[object])
  Claims of the plan
- **total_benefit_amount** (object)
  Total amount benefit of all covers
- **total_benefits** (object)
  Total benefits broken down in to cover types
- **latest_valuations** (array[object])
  The plan's latest valuations (Included when the "latest_valuations" relationship is included)
- **value** (object)
  Total value of the plan
- **valued_at** (string)
  When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at
- **original_valued_at** (string)
  When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.
- **client** (object)
  [DEPRACATED] Please use accounts instead. The plan's client
- **accounts** (array[object])
  The plan's accounts
- **seller** (object)
  Adviser who sold the plan
- **linked_owners** (array[object])
  Other clients who have been linked to this plan
- **linked_plans** (array[object])
  Other plans that have been linked to this plan
- **visible_to_circles** (object)
  Circles which members of circles can see the plan as long as they have the right access level for the circle
- **statistics** (object)
  The statistics on a plan. Only displayed when you retrieve an individual plan
- **cases** (array[object])
  Cases this plan belongs to
- **tags** (array[object])
  Tags this plan have been tagged with
- **is_wrap_product** (boolean)
  Determines if the plan is a wrap plan
- **is_wrap_child** (boolean)
  Determines if the plan is a wrap child
- **wrap** (object)
  Parent wrap plan. if this plan is linked to a wrap product
- **wrap_children** (array[object])
  List of child plans on a wrap product
- **can_be_deleted** (string)
  Denotes if the plan can be deleted
- **contract_enquiry_account** (object)
  The specific account used to make contract enquiry requests.
- **custom_fields** (array[object])
  Any custom fields on the model.
- **external_references** (array[object])
  The external references that have been added to the client.


[Powered by Bump.sh](https://bump.sh)