POST
/
v1
/
companies
/
{company_id}
/
plans

Authorizations

Authorization
string
headerrequired

To authenticate against the API, use HTTP Basic Authentication with your customer ID as the username and API key as the password.

Path Parameters

company_id
string
required

Body

application/json
name
string
required
refill_cadence
enum<string>

How frequently do balances refill

Available options:
MONTHLY,
YEARLY,
DAILY,
NEVER
renewals
object

These are possible renewal cadences that could be selected with their costs.

Example of how you would specify a $10 monthly option and a $110 annual plan (giving someone a discount for committing to a year):

"renewals":{
        "MONTHLY" : {
            "amount": 1000
        },
        "YEARLY" : {
            "amount": 11000
        }
    }
balances
object[]

This is where you specify any balance denominations that should be created and maintained for the account.

Example:

"balances":{
        "tokens": {
            "amount":500
        },
        "credits": {
             "amount":0,
             "variable_amount_cost":200
        }
    }
flags
object