API Reference
Log in
API Reference

Object

Field

Type

Desc

id

string

Pricing Plan ID

price_name

string

Pricing Plan Name

price_alias

string

Pricing Plan Alias

product_id

string

Associated Product ID

merchant_id

string

Merchant ID

currency

string

Currency

billing_type

string

Billing Type:

  • one_time: One-time billing
  • recurring: Recurring billing

price_val

string

One-time payment price, this field is populated when billing_type is one_time

description

string

Pricing Description

price_plan

PricePlan

Pricing Plan

biz_status

string

Pricing Plan Status:

  • draft: Draft
  • active: Active
  • frozen: Frozen

has_trial

bool

Whether to enable trial period

trial_period

PricePlanTier

Trial Period Configuration

created_at

string

Creation Time

PricePlan

Field

Type

Desc

id

string

Price Plan ID

name

string

Plan Name

billing_cycle_unit

string

Billing Cycle Unit:

  • week: Week
  • month: Month
  • quarter: Quarter
  • year: Year

billing_cycle_count

int

Billing cycle count, 0 indicates indefinite

is_infinite

bool

Is Indefinite

base_price_val

string

Base Price Value

plan_description

string

Plan Description

price_plan_tiers

[]PriceTier

Price Plan Tiers List

PriceTier

Field

Type

Desc

billing_cycle_index

int

Billing cycle index, indicating the cycle number

price_val

string

Price value, the specific price for this cycle

discount_type

string

Discount Type:

  • percentage: Percentage discount
  • fixed: Fixed discount

discount_value

string

Discount value, the specific discount amount or percentage

TrialPeriod

Field

Type

Desc

trial_period_unit

string

Trial Period Unit:

  • day: Day
  • week: Week
  • month: Month

trial_period_count

int

Trial Period Count