> ## Documentation Index
> Fetch the complete documentation index at: https://docs.subotiz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Object

Price entity field reference.

| 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 `billing_type` is one\_time                                                                |
| 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<br />0: Free trial<br />1: Paid trial                                                                                 |
| 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. |