Create Charge

POST /charges

Description

Create a new charge configuration.

Authentication

Bearer Token

Request

Headers

Header	Value	Required
Authorization	Bearer {{token}}	Yes
Content-Type	application/json	Yes

Request Body

{
  "name": "ZIMSWITCH",
  "description": "Zimswitch charge",
  "amount": null,
  "account": null,
  "percentageRate": 1.00,
  "flat": null,
  "composite": false,
  "global": false,
  "min": null,
  "max": null,
  "minimumAmount": null,
  "maximumAmount": null,
  "currencyString": "USD",
  "companyIdString": "f5506f1d-3959-41cb-bd7b-c878c34f5a72"
}

Field	Type	Required	Description
name	string	Yes	Name of the charge
description	string	No	Description of the charge
amount	number	No	Fixed amount
account	string	No	Associated account
percentageRate	number	No	Percentage rate
flat	number	No	Flat fee
composite	boolean	No	Whether charge is composite
global	boolean	No	Whether charge is global
min	number	No	Minimum value
max	number	No	Maximum value
minimumAmount	number	No	Minimum amount
maximumAmount	number	No	Maximum amount
currencyString	string	Yes	Currency code
companyIdString	string (UUID)	Yes	Company ID