API Reference
API Reference

Object


FieldTypeDesc
idstringPricing plan ID
price_namestringPricing plan name
price_aliasstringPricing plan alias
product_idstringAssociated product ID
merchant_idstringMerchant ID
currencystringCurrency
billing_typestringBilling type: one_time-one-time, recurring-recurring
price_valstringOne-time payment price, required when billing_type is one_time
descriptionstringPricing description
price_planPricePlanPricing plan
biz_statusstringStatus: draft-draft, active-activated, frozen-frozen
has_trialbooleanWhether trial period is enabled: 0-no, 1-yes
trial_periodTrialPeriodTrial period configuration
created_atstringCreation time
price_typestringPrice Type
usage_amountstringUsage Amount
usage_unitstringUsage Unit
model_typestringModel Type
billing_thresholdstringBilling Threshold
trial_typeintTrial type
  • 0: Free trial
  • 1: Paid trial
trial_amountstringTrial amount
metadatamap[string]stringA set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format.

PricePlan

FieldTypeDesc
idstringPricing plan ID, system-generated unique identifier
namestringPlan name, name displayed to users
billing_cycle_unitstringBilling cycle unit, such as: day, week, month, year, etc.
billing_cycle_countintBilling cycle count, such as: 1 month, 3 months, etc.
is_infinitebooleanWhether unlimited, true means permanently valid
base_price_valstringBase price, base pricing of the plan
plan_descriptionstringPlan description, detailed plan information
price_plan_tiersPriceTier[]Tiered pricing details, specific prices for different cycles

PriceTier

FieldTypeDesc
billing_cycle_indexintBilling cycle index, indicating which cycle
price_valstringPrice value, specific price for this cycle
discount_typestringDiscount type, such as: percentage, fixed, etc.
discount_valuestringDiscount value, specific discount amount or percentage

TrialPeriod

FieldTypeDesc
trial_period_unitstringTrial period unit, required, such as: day, week, month, etc.
trial_period_countintTrial period count, required, such as: 7 days, 1 month, etc.