Skip to content

SchemasCommerceSubscriptionItemPlan.md

Latest commit

 

History

History
38 lines (34 loc) · 17 KB

SchemasCommerceSubscriptionItemPlan.md

File metadata and controls

38 lines (34 loc) · 17 KB
Raw

SchemasCommerceSubscriptionItemPlan

The associated commerce plan.

Fields

Field Type Required Description
object SchemasCommerceSubscriptionItemPlanObject ✔️ String representing the object's type. Objects of the same type share the same value.
id String ✔️ Unique identifier for the commerce plan.
name String ✔️ The name of the commerce plan.
fee Optional<SchemasCommerceSubscriptionItemFee> ✔️ N/A
annualMonthlyFee Optional<SchemasCommerceSubscriptionItemAnnualMonthlyFee> ✔️ N/A
annualFee Optional<SchemasCommerceSubscriptionItemAnnualFee> ✔️ N/A
amount long ✔️ The amount in cents for the plan.
amountFormatted String ✔️ The formatted amount as a string (e.g., "$49.99").
annualMonthlyAmount long ✔️ The monthly amount in cents when billed annually.
annualMonthlyAmountFormatted String ✔️ The formatted annual monthly amount as a string.
annualAmount long ✔️ The total annual amount in cents.
annualAmountFormatted String ✔️ The formatted annual amount as a string.
currencySymbol String ✔️ The currency symbol (e.g., "$").
currency String ✔️ The currency code (e.g., "USD").
description String ✔️ The description of the commerce plan.
productId String ✔️ The ID of the product this plan belongs to.
isDefault boolean ✔️ Whether this is the default plan.
isRecurring boolean ✔️ Whether this is a recurring plan.
publiclyVisible boolean ✔️ Whether this plan is publicly visible.
hasBaseFee boolean ✔️ Whether this plan has a base fee.
payerType List<String> ✔️ The types of payers that can use this plan.
forPayerType String ✔️ The payer type this plan is designed for.
slug String ✔️ The URL-friendly slug for the plan.
avatarUrl String ✔️ The URL of the plan's avatar image.
period Optional<String> ➖ The billing period for the plan.
interval Optional<Long> ➖ The billing interval.
features List<SchemasFeatureResponse> ✔️ The features included in this plan.
freeTrialEnabled Optional<Boolean> ➖ Whether free trial is enabled for this plan.
freeTrialDays JsonNullable<Long> ➖ Number of free trial days for this plan.