# Create a premium

**POST /api/v1/plans/{plan_uuid}/premiums**




## 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
- **plan_uuid** (string)



### Body: application/json (object)

- **transfer_type** (string)
  Transfer type. Possible values are: switch and transfer
- **date_advice_given** (string(date))
  Date advice given
- **amount** (integer)
  Premium amount in pennies. Either amount or percentage can be given in request
- **percentage** (float)
  Premium percentage of the plans pensionable salary. Either amount or percentage can be given in request
- **frequency** (string)
  Premium frequency
- **source** (string)
  Premium source, only for pension plans. Possible values are: employee and employer
- **payment_method** (string)
  Payment method. Possible values are: salary_sacrifice, salary_deduction, direct_debit, standing_order, cheque and bank_transfer
- **start_date** (string(date))
  Start date
- **end_date** (string(date))
  End date. Leave blank for ongoing
- **details** (string)
  Details
- **transferred_from_plan_uuid** (string(uuid))
  The plan UUID this premium was transferred from
- **transferred_from_plan_type** (string)
  The plan type this premium was transferred from if the actual plan UUID is unknown
- **transferred_from_plan_sub_type** (string)
  The plan sub type this premium was transferred from if the actual plan UUID is unknown
- **external_reference** (object)
  A third-party external reference to attach when creating the model.


## Responses
### 201


#### 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.
- **transfer_type** (string)
  Transfer type
- **date_of_transfer_valuation** (string)
  Date of transfer valuation
- **date_advice_given** (string)
  Date advice given
- **premium** (integer)
  The calculated premium amount which is received at frequency intervals
- **premium_monthly** (integer)
  The calculated premium amount which is received as a monthly value
- **premium_annually** (integer)
  The calculated premium amount which is received as an annual value
- **total_premium_to_date** (integer)
  The total of this premium so far to current date or end date according to frequency
- **amount** (integer)
  Premium amount in pennies. Either amount or percentage can be given in request
- **percentage** (number)
  Premium percentage of the plans pensionable salary. Either amount or percentage can be given in request
- **frequency** (string)
  Frequency of the premium
- **source** (string)
  Premium source. Only required for pension plans
- **payment_method** (string)
  Payment method
- **start_date** (string)
  Start date
- **end_date** (string)
  End date. Blank for ongoing
- **pensionable_salary** (integer)
  The pensionable salary that was used to calculate percentage based premium
- **details** (string)
  Details
- **created_by** (object)
  Account that created this premium
- **plan** (object)
  Plan this premium belongs to, only if included
- **transferred_from_plan** (object)
  Plan this premium was transferred from
- **transferred_from_plan_type** (string)
  Plan type this premium was transferred from if the actual plan is unknown
- **transferred_from_plan_sub_type** (string)
  Plan sub type this premium was transferred from if the actual plan is unknown


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