Create plan usage threshold

POST

/v1/plans/{plan_code}/usage_thresholds

Add a usage threshold to a plan.

Parameters

Path Parameters

plan_code

required

Plan Code

string

Request Body ^required

UsageThresholdCreateAPI

object

amount_cents

required

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

currency

Currency

string

default: USD >= 3 characters <= 3 characters

recurring

Recurring

boolean

threshold_display_name

Any of:

string

string

<= 255 characters

null

null

Responses

201

Successful Response

UsageThresholdResponse

object

id

required

Id

string format: uuid

plan_id

Any of:

string

string format: uuid

null

null

subscription_id

Any of:

string

string format: uuid

null

null

amount_cents

required

Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

currency

required

Currency

string

recurring

required

Recurring

boolean

threshold_display_name

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized

404

Plan not found

422

Validation error