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, recurring-recurring |
price_val | string | One-time payment price, required when |
description | string | Pricing description |
price_plan | PricePlan | Pricing plan |
biz_status | string | Status: draft-draft, active-activated, frozen-frozen |
has_trial | boolean | Whether trial period is enabled: 0-no, 1-yes |
trial_period | TrialPeriod | Trial period configuration |
created_at | string | Creation time |
price_type | string | Price Type |
usage_amount | string | Usage Amount |
usage_unit | string | Usage Unit |
model_type | string | Model Type |
billing_threshold | string | Billing Threshold |
trial_type | int | Trial type
|
trial_amount | string | Trial amount |
metadata | map[string]string | A set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format. |
PricePlan
| Field | Type | Desc |
|---|---|---|
| id | string | Pricing plan ID, system-generated unique identifier |
| name | string | Plan name, name displayed to users |
| billing_cycle_unit | string | Billing cycle unit, such as: day, week, month, year, etc. |
| billing_cycle_count | int | Billing cycle count, such as: 1 month, 3 months, etc. |
| is_infinite | boolean | Whether unlimited, true means permanently valid |
| base_price_val | string | Base price, base pricing of the plan |
| plan_description | string | Plan description, detailed plan information |
| price_plan_tiers | PriceTier[] | Tiered pricing details, specific prices for different cycles |
PriceTier
| Field | Type | Desc |
|---|---|---|
| billing_cycle_index | int | Billing cycle index, indicating which cycle |
| price_val | string | Price value, specific price for this cycle |
| discount_type | string | Discount type, such as: percentage, fixed, etc. |
| discount_value | string | Discount value, specific discount amount or percentage |
TrialPeriod
| Field | Type | Desc |
|---|---|---|
| trial_period_unit | string | Trial period unit, required, such as: day, week, month, etc. |
| trial_period_count | int | Trial period count, required, such as: 7 days, 1 month, etc. |