Skip to main content
POST
cURL

Path Parameters

businessId
string
required

Body

id
integer<int64>
key
string | null
limit
integer<int32> | null
period
enum<string>
Available options:
DAILY,
WEEKLY,
MONTHLY,
YEARLY,
LIFETIME
planId
integer<int64> | null
plan
object
usageId
integer<int64> | null
usage
object
userId
integer<int64> | null
businessId
integer<int64> | null
isActive
boolean
billingCycleAnchor
string<date-time> | null
pendingLimit
integer<int32> | null
pendingLimitEffectiveAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time> | null

Response

OK

id
integer<int64>
key
string | null
limit
integer<int32> | null
isUnlimited
boolean
read-only
period
enum<string>
Available options:
DAILY,
WEEKLY,
MONTHLY,
YEARLY,
LIFETIME
planId
integer<int64> | null
plan
object
usageId
integer<int64> | null
usage
object
userId
integer<int64> | null
businessId
integer<int64> | null
isActive
boolean
billingCycleAnchor
string<date-time> | null
pendingLimit
integer<int32> | null
pendingLimitEffectiveAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time> | null