Subscription Pricing Scheme
June 5, 2026 ยท View on GitHub
The pricing scheme details.
Structure
SubscriptionPricingScheme
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
Version | Integer | Optional, Read-only | The version of the pricing scheme. Constraints: >= 0, <= 999 | Integer getVersion() | setVersion(Integer version) |
FixedPrice | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getFixedPrice() | setFixedPrice(Money fixedPrice) |
PricingModel | SubscriptionPricingModel | Optional | The pricing model for tiered plan. The tiers parameter is required.Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$ | SubscriptionPricingModel getPricingModel() | setPricingModel(SubscriptionPricingModel pricingModel) |
Tiers | List<PricingTier> | Optional | An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified. Constraints: Minimum Items: 1, Maximum Items: 32 | List | setTiers(List |
CreateTime | String | Optional | The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$ | String getCreateTime() | setCreateTime(String createTime) |
UpdateTime | String | Optional | The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$ | String getUpdateTime() | setUpdateTime(String updateTime) |
Example (as JSON)
{
"version": 172,
"fixed_price": {
"currency_code": "currency_code4",
"value": "value0"
},
"pricing_model": "VOLUME",
"tiers": [
{
"starting_quantity": "starting_quantity8",
"ending_quantity": "ending_quantity6",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
}
},
{
"starting_quantity": "starting_quantity8",
"ending_quantity": "ending_quantity6",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
}
},
{
"starting_quantity": "starting_quantity8",
"ending_quantity": "ending_quantity6",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
}
}
],
"create_time": "create_time2"
}