# Create a charge

**POST /api/v1/charge**

Create recurring charge for a given plan or client.
Amount can be a fixed amount or a percentage of a plans value.


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


## Authentication methods
- Personal access token & O auth2


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




### Body: application/json (object)

- **chargeable_type** (string)
  Model type that can have charges added to them. Valid types are: client, plan
- **chargeable_uuid** (string)
  UUID of chargeable model.
- **seller_uuid** (string)
  Employee that will be earning the revenue for this charge
- **payment_origin** (string)
  Who is expected to pay this. Values are: client, provider and unknown
- **type** (string)
  Expectation type. Possible values are: fee and commission
- **category** (string)
  Expectation category. Possible values are: adhoc, administration, adjustment, bond_renewal, clawback, dss_rebate, fund, indemnity, initial_fee, level, non_indemnity, one_off, ongoing_fee, other_fee, procuration_fee, protected_rights, renewal, switch and unknown
- **recurring** (boolean)
  Determines whether the charge recurs at a set frequency.  False for a one off statement transactions
- **frequency** (string)
  Charge frequency from the given start date. Valid frequencies are: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, and annually
- **start_date** (date)
  Date the recurring charge starts from.
- **end_date** (date)
  Date the recurring statement transactions will stop. Leave blank for indefinitely or until charge schedule is deleted.
- **amount** (integer)
  The fixed amount value as an integer in pennies. Required when not providing a percentage or when chargeable_type is client.
- **percentage** (number)
  Percentage of plans value as a charge.  Required when not providing a fixed amount.  Cannot use percentage for a client chargeable_type.
- **percentage_frequency** (string)
  Frequency that describes what the percentage is calculated from. Valid frequencies are: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, and annually
- **tax_exempt** (boolean)
  Denotes whether the charge is exempt from tax.
- **tax** (number)
  Percentage tax to be added on to net amount of charge. Will use fims default tax rate if not provided and charge is not tax exempt.
- **exclude_from_rmar** (string)
  Whether or not to exclude this charge and its expectations from RMAR reporting.
- **advice_type** (string)
  Advice type for the charge. Possible values are: independent and restricted
- **service_type** (string)
  Service type for the charge. Possible values are: initial, one_off and ongoing. Recurring charges must be "ongoing"
- **rmar_type** (string)
  RMAR type for the charge. Can only be set for adjustments and unknown charge categories. All other categories are automatically calculated. Possible values are: adviser_charge, clawback, commission, other_fee and unknown. Recurring charges must be "ongoing"
- **premium_uuid** (string)
  UUID of premium a percentage charge is based from.
- **advice_area** (array[string])
  RMAR advice area values. Required for charges made directly on a client. All amounts are in pennies and must total the charge net amount.
- **notes** (string)
  Notes to add on to the charge.


## Responses
### 401


#### Body: application/json (object)
- **message** (string)



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