Skip to main content
POST
Create Pricing

Authorizations

Authorization
string
header
required

Bearer API Key authentication. Format: Authorization: Bearer {your_api_key}

Headers

Request-Id
string
default:008e3967-a1b5-48bb-be14-d5bff5092e61
required

The unique identifier of the request

Body

application/json

Create price request

name
string
required

Price name

product_id
string
required

Associated product ID

product_version_id
string
required

Product version ID

billing_type
string
required

Billing type: one_time/recurring

description
string
required

Price description

price_type
string
required

Price type, one of the following: flat_price | package_price | based_on_usage

price_val
string

One-time payment price, required when billing_type is one_time

has_trial
boolean

Whether trial period is enabled

trial_period
object

Trial period configuration

price_plan
object

Price plan, required when billing_type is recurring

usage_amount
string

Usage amount, required when price_type is based_on_usage or package_price

usage_unit
string

Usage unit, required when price_type is based_on_usage or package_price

features
object[]

Price features

model_type
string

Model type, one of the following: per_unit | tiers_price, required when price_type is based_on_usage

billing_threshold
string

Billing threshold, required when model_type is per_unit

trial_type
integer<int32>

Trial type, one of the following: 0 - Free trial | 1 - Paid trial

trial_amount
string

Trial amount, required when trial_type is 1 - Paid trial

status
string

Status:

  • draft: Draft
  • active: Activated
  • frozen: Frozen

Response

200 - application/json

OK

Create price response

code
string

error code

message
string

error message

data
object

Create price response