Skip to content

Create subscription usage threshold

POST
/v1/subscriptions/{subscription_id}/usage_thresholds

Add a usage threshold to a subscription.

subscription_id
required
Subscription Id
string format: uuid
UsageThresholdCreateAPI
object
amount_cents
required
Any of:
number
currency
Currency
string
default: USD >= 3 characters <= 3 characters
recurring
Recurring
boolean
threshold_display_name
Any of:
string
<= 255 characters

Successful Response

UsageThresholdResponse
object
id
required
Id
string format: uuid
plan_id
Any of:
string format: uuid
subscription_id
Any of:
string format: uuid
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
currency
required
Currency
string
recurring
required
Recurring
boolean
threshold_display_name
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized

Subscription not found

Validation error