6.2 KiB
6.2 KiB
PlanItemPrice
Fields
| Field | Type | Required | Description |
|---|---|---|---|
amount |
Optional[float] | ➖ | Price per billing_units after included usage is consumed. Mutually exclusive with tiers. |
tiers |
List[models.PlanTier] | ➖ | Tiered pricing configuration. Each tier's 'up_to' does NOT include the included amount. Either 'tiers' or 'amount' is required. |
interval |
models.PlanPriceItemInterval | ✔️ | Billing interval for this price. For consumable features, should match reset.interval. |
interval_count |
Optional[float] | ➖ | Number of intervals per billing cycle. Defaults to 1. |
billing_units |
float | ✔️ | Number of units per price increment. Usage is rounded UP to the nearest billing_units when billed (e.g. billing_units=100 means 101 usage rounds to 200). |
billing_method |
models.PlanBillingMethod | ✔️ | 'prepaid' for features like seats where customers pay upfront, 'usage_based' for pay-as-you-go after included usage. |
max_purchase |
Nullable[float] | ✔️ | Maximum units a customer can purchase beyond included. E.g. if included=100 and max_purchase=300, customer can use up to 400 total before usage is capped. Null for no limit. |