Create Company Plan

A plan basically acts as a template of account balance denominations and parameters that you can apply to an account upon creation

POST /v1/companies/{company_id}/plans

Try it

Create Company Plan

cURL

curl --request POST \
  --url https://api.gofermata.com/v1/companies/{company_id}/plans \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "charge_amount": 0,
  "charge_denomination": "string",
  "billing_period": "string",
  "rollover": true,
  "balances": [
    {
      "amount": "string",
      "denomination": "string",
      "overage_charge_amount": 0,
      "overage_charge_denomination": "string",
      "auto_refill_amount": 0,
      "auto_refill_threshold": 0
    }
  ]
}
'

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

company_id · string · required

Body

application/json

charge_amount · integer · required

charge_denomination · string · required

billing_period · string · required

name · string

rollover · boolean

Should all existing balances be cleared when a new billing period starts?

threshold_alert_percentage · integer

Causes a webhook to be sent when any of the balances drops below the given percentage

balances · object[]

Minimum array length: 1

Show child attributes

balances. amount · string

balances. denomination · string

balances. overage_charge_amount · integer

If this is set, then once this treasury account hits zero then instead of going negative, charges are processed against a different denomination instead for a given amount

balances. overage_charge_denomination · string

balances. auto_refill_amount · integer

balances. auto_refill_threshold · integer

Response

200

OK