CustomerUnitCapInput

The cap to apply.

amount
Type: number
greater than:
0
required

Most credits the unit and every unit beneath it may use per period, in the cap's credits currency.
creditsCurrencyId
Type: string

The credits currency (cc_…) to cap. Required when your organisation has more than one.
effectiveFrom
Type: stringFormat: date-time

When this cap starts to apply. Defaults to now; a future moment schedules it.
frequency
enum
const:
MONTHLY

How often the allowance resets.
schedule

When periods start. Defaults to the schedule of the cap in force at effectiveFrom, or for a first cap, monthly periods anchored on today's day of the month (UTC).
When periods start. Defaults to the schedule of the cap in force at effectiveFrom, or for a first cap, monthly periods anchored on today's day of the month (UTC).
type
const:
CALENDAR
required