orb-billing 5.15.0 → 5.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/package.json +1 -1
- package/resources/beta/beta.d.ts +396 -2
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/external-plan-id.d.ts +396 -2
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/items.d.ts +37 -0
- package/resources/items.d.ts.map +1 -1
- package/resources/items.js.map +1 -1
- package/resources/items.mjs.map +1 -1
- package/resources/plans/plans.d.ts +198 -1
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/prices.d.ts +558 -3
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/shared.d.ts +280 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/shared.js.map +1 -1
- package/resources/shared.mjs.map +1 -1
- package/resources/subscriptions.d.ts +1104 -131
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/resources/beta/beta.ts +468 -0
- package/src/resources/beta/external-plan-id.ts +468 -0
- package/src/resources/items.ts +38 -0
- package/src/resources/plans/plans.ts +234 -0
- package/src/resources/prices/prices.ts +688 -28
- package/src/resources/shared.ts +337 -1
- package/src/resources/subscriptions.ts +1250 -94
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -190,7 +190,7 @@ export declare namespace PriceEvaluatePreviewEventsResponse {
|
|
|
190
190
|
price_id?: string | null;
|
|
191
191
|
}
|
|
192
192
|
}
|
|
193
|
-
export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingMinimumCompositePrice;
|
|
193
|
+
export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingMinimumCompositePrice | PriceCreateParams.NewFloatingPercentCompositePrice | PriceCreateParams.NewFloatingEventOutputPrice;
|
|
194
194
|
export declare namespace PriceCreateParams {
|
|
195
195
|
interface NewFloatingUnitPrice {
|
|
196
196
|
/**
|
|
@@ -2967,6 +2967,191 @@ export declare namespace PriceCreateParams {
|
|
|
2967
2967
|
prorated?: boolean;
|
|
2968
2968
|
}
|
|
2969
2969
|
}
|
|
2970
|
+
interface NewFloatingPercentCompositePrice {
|
|
2971
|
+
/**
|
|
2972
|
+
* The cadence to bill for this price on.
|
|
2973
|
+
*/
|
|
2974
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
2975
|
+
/**
|
|
2976
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
2977
|
+
*/
|
|
2978
|
+
currency: string;
|
|
2979
|
+
/**
|
|
2980
|
+
* The id of the item the price will be associated with.
|
|
2981
|
+
*/
|
|
2982
|
+
item_id: string;
|
|
2983
|
+
/**
|
|
2984
|
+
* The pricing model type
|
|
2985
|
+
*/
|
|
2986
|
+
model_type: 'percent';
|
|
2987
|
+
/**
|
|
2988
|
+
* The name of the price.
|
|
2989
|
+
*/
|
|
2990
|
+
name: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* Configuration for percent pricing
|
|
2993
|
+
*/
|
|
2994
|
+
percent_config: NewFloatingPercentCompositePrice.PercentConfig;
|
|
2995
|
+
/**
|
|
2996
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
2997
|
+
* usage-based.
|
|
2998
|
+
*/
|
|
2999
|
+
billable_metric_id?: string | null;
|
|
3000
|
+
/**
|
|
3001
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3002
|
+
* this is true, and in-arrears if this is false.
|
|
3003
|
+
*/
|
|
3004
|
+
billed_in_advance?: boolean | null;
|
|
3005
|
+
/**
|
|
3006
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3007
|
+
* months.
|
|
3008
|
+
*/
|
|
3009
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3010
|
+
/**
|
|
3011
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3012
|
+
*/
|
|
3013
|
+
conversion_rate?: number | null;
|
|
3014
|
+
/**
|
|
3015
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3016
|
+
*/
|
|
3017
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3018
|
+
/**
|
|
3019
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3020
|
+
*/
|
|
3021
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3022
|
+
/**
|
|
3023
|
+
* An alias for the price.
|
|
3024
|
+
*/
|
|
3025
|
+
external_price_id?: string | null;
|
|
3026
|
+
/**
|
|
3027
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3028
|
+
* applied.
|
|
3029
|
+
*/
|
|
3030
|
+
fixed_price_quantity?: number | null;
|
|
3031
|
+
/**
|
|
3032
|
+
* The property used to group this price on an invoice
|
|
3033
|
+
*/
|
|
3034
|
+
invoice_grouping_key?: string | null;
|
|
3035
|
+
/**
|
|
3036
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3037
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3038
|
+
*/
|
|
3039
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3040
|
+
/**
|
|
3041
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3042
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3043
|
+
* by setting `metadata` to `null`.
|
|
3044
|
+
*/
|
|
3045
|
+
metadata?: {
|
|
3046
|
+
[key: string]: string | null;
|
|
3047
|
+
} | null;
|
|
3048
|
+
}
|
|
3049
|
+
namespace NewFloatingPercentCompositePrice {
|
|
3050
|
+
/**
|
|
3051
|
+
* Configuration for percent pricing
|
|
3052
|
+
*/
|
|
3053
|
+
interface PercentConfig {
|
|
3054
|
+
/**
|
|
3055
|
+
* What percent of the component subtotals to charge
|
|
3056
|
+
*/
|
|
3057
|
+
percent: number;
|
|
3058
|
+
}
|
|
3059
|
+
}
|
|
3060
|
+
interface NewFloatingEventOutputPrice {
|
|
3061
|
+
/**
|
|
3062
|
+
* The cadence to bill for this price on.
|
|
3063
|
+
*/
|
|
3064
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3065
|
+
/**
|
|
3066
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
3067
|
+
*/
|
|
3068
|
+
currency: string;
|
|
3069
|
+
/**
|
|
3070
|
+
* Configuration for event_output pricing
|
|
3071
|
+
*/
|
|
3072
|
+
event_output_config: NewFloatingEventOutputPrice.EventOutputConfig;
|
|
3073
|
+
/**
|
|
3074
|
+
* The id of the item the price will be associated with.
|
|
3075
|
+
*/
|
|
3076
|
+
item_id: string;
|
|
3077
|
+
/**
|
|
3078
|
+
* The pricing model type
|
|
3079
|
+
*/
|
|
3080
|
+
model_type: 'event_output';
|
|
3081
|
+
/**
|
|
3082
|
+
* The name of the price.
|
|
3083
|
+
*/
|
|
3084
|
+
name: string;
|
|
3085
|
+
/**
|
|
3086
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3087
|
+
* usage-based.
|
|
3088
|
+
*/
|
|
3089
|
+
billable_metric_id?: string | null;
|
|
3090
|
+
/**
|
|
3091
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3092
|
+
* this is true, and in-arrears if this is false.
|
|
3093
|
+
*/
|
|
3094
|
+
billed_in_advance?: boolean | null;
|
|
3095
|
+
/**
|
|
3096
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3097
|
+
* months.
|
|
3098
|
+
*/
|
|
3099
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3100
|
+
/**
|
|
3101
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3102
|
+
*/
|
|
3103
|
+
conversion_rate?: number | null;
|
|
3104
|
+
/**
|
|
3105
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3106
|
+
*/
|
|
3107
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3108
|
+
/**
|
|
3109
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3110
|
+
*/
|
|
3111
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3112
|
+
/**
|
|
3113
|
+
* An alias for the price.
|
|
3114
|
+
*/
|
|
3115
|
+
external_price_id?: string | null;
|
|
3116
|
+
/**
|
|
3117
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3118
|
+
* applied.
|
|
3119
|
+
*/
|
|
3120
|
+
fixed_price_quantity?: number | null;
|
|
3121
|
+
/**
|
|
3122
|
+
* The property used to group this price on an invoice
|
|
3123
|
+
*/
|
|
3124
|
+
invoice_grouping_key?: string | null;
|
|
3125
|
+
/**
|
|
3126
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3127
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3128
|
+
*/
|
|
3129
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3130
|
+
/**
|
|
3131
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3132
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3133
|
+
* by setting `metadata` to `null`.
|
|
3134
|
+
*/
|
|
3135
|
+
metadata?: {
|
|
3136
|
+
[key: string]: string | null;
|
|
3137
|
+
} | null;
|
|
3138
|
+
}
|
|
3139
|
+
namespace NewFloatingEventOutputPrice {
|
|
3140
|
+
/**
|
|
3141
|
+
* Configuration for event_output pricing
|
|
3142
|
+
*/
|
|
3143
|
+
interface EventOutputConfig {
|
|
3144
|
+
/**
|
|
3145
|
+
* The key in the event data to extract the unit rate from.
|
|
3146
|
+
*/
|
|
3147
|
+
unit_rating_key: string;
|
|
3148
|
+
/**
|
|
3149
|
+
* An optional key in the event data to group by (e.g., event ID). All events will
|
|
3150
|
+
* also be grouped by their unit rate.
|
|
3151
|
+
*/
|
|
3152
|
+
grouping_key?: string | null;
|
|
3153
|
+
}
|
|
3154
|
+
}
|
|
2970
3155
|
}
|
|
2971
3156
|
export interface PriceUpdateParams {
|
|
2972
3157
|
/**
|
|
@@ -3053,7 +3238,7 @@ export declare namespace PriceEvaluateMultipleParams {
|
|
|
3053
3238
|
/**
|
|
3054
3239
|
* New floating price request body params.
|
|
3055
3240
|
*/
|
|
3056
|
-
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | null;
|
|
3241
|
+
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
|
|
3057
3242
|
/**
|
|
3058
3243
|
* The ID of a price to evaluate that exists in your Orb account.
|
|
3059
3244
|
*/
|
|
@@ -3162,6 +3347,191 @@ export declare namespace PriceEvaluateMultipleParams {
|
|
|
3162
3347
|
per_unit_rate: string;
|
|
3163
3348
|
}
|
|
3164
3349
|
}
|
|
3350
|
+
interface NewFloatingPercentCompositePrice {
|
|
3351
|
+
/**
|
|
3352
|
+
* The cadence to bill for this price on.
|
|
3353
|
+
*/
|
|
3354
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3355
|
+
/**
|
|
3356
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
3357
|
+
*/
|
|
3358
|
+
currency: string;
|
|
3359
|
+
/**
|
|
3360
|
+
* The id of the item the price will be associated with.
|
|
3361
|
+
*/
|
|
3362
|
+
item_id: string;
|
|
3363
|
+
/**
|
|
3364
|
+
* The pricing model type
|
|
3365
|
+
*/
|
|
3366
|
+
model_type: 'percent';
|
|
3367
|
+
/**
|
|
3368
|
+
* The name of the price.
|
|
3369
|
+
*/
|
|
3370
|
+
name: string;
|
|
3371
|
+
/**
|
|
3372
|
+
* Configuration for percent pricing
|
|
3373
|
+
*/
|
|
3374
|
+
percent_config: NewFloatingPercentCompositePrice.PercentConfig;
|
|
3375
|
+
/**
|
|
3376
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3377
|
+
* usage-based.
|
|
3378
|
+
*/
|
|
3379
|
+
billable_metric_id?: string | null;
|
|
3380
|
+
/**
|
|
3381
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3382
|
+
* this is true, and in-arrears if this is false.
|
|
3383
|
+
*/
|
|
3384
|
+
billed_in_advance?: boolean | null;
|
|
3385
|
+
/**
|
|
3386
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3387
|
+
* months.
|
|
3388
|
+
*/
|
|
3389
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3390
|
+
/**
|
|
3391
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3392
|
+
*/
|
|
3393
|
+
conversion_rate?: number | null;
|
|
3394
|
+
/**
|
|
3395
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3396
|
+
*/
|
|
3397
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3398
|
+
/**
|
|
3399
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3400
|
+
*/
|
|
3401
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3402
|
+
/**
|
|
3403
|
+
* An alias for the price.
|
|
3404
|
+
*/
|
|
3405
|
+
external_price_id?: string | null;
|
|
3406
|
+
/**
|
|
3407
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3408
|
+
* applied.
|
|
3409
|
+
*/
|
|
3410
|
+
fixed_price_quantity?: number | null;
|
|
3411
|
+
/**
|
|
3412
|
+
* The property used to group this price on an invoice
|
|
3413
|
+
*/
|
|
3414
|
+
invoice_grouping_key?: string | null;
|
|
3415
|
+
/**
|
|
3416
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3417
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3418
|
+
*/
|
|
3419
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3420
|
+
/**
|
|
3421
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3422
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3423
|
+
* by setting `metadata` to `null`.
|
|
3424
|
+
*/
|
|
3425
|
+
metadata?: {
|
|
3426
|
+
[key: string]: string | null;
|
|
3427
|
+
} | null;
|
|
3428
|
+
}
|
|
3429
|
+
namespace NewFloatingPercentCompositePrice {
|
|
3430
|
+
/**
|
|
3431
|
+
* Configuration for percent pricing
|
|
3432
|
+
*/
|
|
3433
|
+
interface PercentConfig {
|
|
3434
|
+
/**
|
|
3435
|
+
* What percent of the component subtotals to charge
|
|
3436
|
+
*/
|
|
3437
|
+
percent: number;
|
|
3438
|
+
}
|
|
3439
|
+
}
|
|
3440
|
+
interface NewFloatingEventOutputPrice {
|
|
3441
|
+
/**
|
|
3442
|
+
* The cadence to bill for this price on.
|
|
3443
|
+
*/
|
|
3444
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3445
|
+
/**
|
|
3446
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
3447
|
+
*/
|
|
3448
|
+
currency: string;
|
|
3449
|
+
/**
|
|
3450
|
+
* Configuration for event_output pricing
|
|
3451
|
+
*/
|
|
3452
|
+
event_output_config: NewFloatingEventOutputPrice.EventOutputConfig;
|
|
3453
|
+
/**
|
|
3454
|
+
* The id of the item the price will be associated with.
|
|
3455
|
+
*/
|
|
3456
|
+
item_id: string;
|
|
3457
|
+
/**
|
|
3458
|
+
* The pricing model type
|
|
3459
|
+
*/
|
|
3460
|
+
model_type: 'event_output';
|
|
3461
|
+
/**
|
|
3462
|
+
* The name of the price.
|
|
3463
|
+
*/
|
|
3464
|
+
name: string;
|
|
3465
|
+
/**
|
|
3466
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3467
|
+
* usage-based.
|
|
3468
|
+
*/
|
|
3469
|
+
billable_metric_id?: string | null;
|
|
3470
|
+
/**
|
|
3471
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3472
|
+
* this is true, and in-arrears if this is false.
|
|
3473
|
+
*/
|
|
3474
|
+
billed_in_advance?: boolean | null;
|
|
3475
|
+
/**
|
|
3476
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3477
|
+
* months.
|
|
3478
|
+
*/
|
|
3479
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3480
|
+
/**
|
|
3481
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3482
|
+
*/
|
|
3483
|
+
conversion_rate?: number | null;
|
|
3484
|
+
/**
|
|
3485
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3486
|
+
*/
|
|
3487
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3488
|
+
/**
|
|
3489
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3490
|
+
*/
|
|
3491
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3492
|
+
/**
|
|
3493
|
+
* An alias for the price.
|
|
3494
|
+
*/
|
|
3495
|
+
external_price_id?: string | null;
|
|
3496
|
+
/**
|
|
3497
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3498
|
+
* applied.
|
|
3499
|
+
*/
|
|
3500
|
+
fixed_price_quantity?: number | null;
|
|
3501
|
+
/**
|
|
3502
|
+
* The property used to group this price on an invoice
|
|
3503
|
+
*/
|
|
3504
|
+
invoice_grouping_key?: string | null;
|
|
3505
|
+
/**
|
|
3506
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3507
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3508
|
+
*/
|
|
3509
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3510
|
+
/**
|
|
3511
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3512
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3513
|
+
* by setting `metadata` to `null`.
|
|
3514
|
+
*/
|
|
3515
|
+
metadata?: {
|
|
3516
|
+
[key: string]: string | null;
|
|
3517
|
+
} | null;
|
|
3518
|
+
}
|
|
3519
|
+
namespace NewFloatingEventOutputPrice {
|
|
3520
|
+
/**
|
|
3521
|
+
* Configuration for event_output pricing
|
|
3522
|
+
*/
|
|
3523
|
+
interface EventOutputConfig {
|
|
3524
|
+
/**
|
|
3525
|
+
* The key in the event data to extract the unit rate from.
|
|
3526
|
+
*/
|
|
3527
|
+
unit_rating_key: string;
|
|
3528
|
+
/**
|
|
3529
|
+
* An optional key in the event data to group by (e.g., event ID). All events will
|
|
3530
|
+
* also be grouped by their unit rate.
|
|
3531
|
+
*/
|
|
3532
|
+
grouping_key?: string | null;
|
|
3533
|
+
}
|
|
3534
|
+
}
|
|
3165
3535
|
}
|
|
3166
3536
|
}
|
|
3167
3537
|
export interface PriceEvaluatePreviewEventsParams {
|
|
@@ -3239,7 +3609,7 @@ export declare namespace PriceEvaluatePreviewEventsParams {
|
|
|
3239
3609
|
/**
|
|
3240
3610
|
* New floating price request body params.
|
|
3241
3611
|
*/
|
|
3242
|
-
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | null;
|
|
3612
|
+
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
|
|
3243
3613
|
/**
|
|
3244
3614
|
* The ID of a price to evaluate that exists in your Orb account.
|
|
3245
3615
|
*/
|
|
@@ -3348,6 +3718,191 @@ export declare namespace PriceEvaluatePreviewEventsParams {
|
|
|
3348
3718
|
per_unit_rate: string;
|
|
3349
3719
|
}
|
|
3350
3720
|
}
|
|
3721
|
+
interface NewFloatingPercentCompositePrice {
|
|
3722
|
+
/**
|
|
3723
|
+
* The cadence to bill for this price on.
|
|
3724
|
+
*/
|
|
3725
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3726
|
+
/**
|
|
3727
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
3728
|
+
*/
|
|
3729
|
+
currency: string;
|
|
3730
|
+
/**
|
|
3731
|
+
* The id of the item the price will be associated with.
|
|
3732
|
+
*/
|
|
3733
|
+
item_id: string;
|
|
3734
|
+
/**
|
|
3735
|
+
* The pricing model type
|
|
3736
|
+
*/
|
|
3737
|
+
model_type: 'percent';
|
|
3738
|
+
/**
|
|
3739
|
+
* The name of the price.
|
|
3740
|
+
*/
|
|
3741
|
+
name: string;
|
|
3742
|
+
/**
|
|
3743
|
+
* Configuration for percent pricing
|
|
3744
|
+
*/
|
|
3745
|
+
percent_config: NewFloatingPercentCompositePrice.PercentConfig;
|
|
3746
|
+
/**
|
|
3747
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3748
|
+
* usage-based.
|
|
3749
|
+
*/
|
|
3750
|
+
billable_metric_id?: string | null;
|
|
3751
|
+
/**
|
|
3752
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3753
|
+
* this is true, and in-arrears if this is false.
|
|
3754
|
+
*/
|
|
3755
|
+
billed_in_advance?: boolean | null;
|
|
3756
|
+
/**
|
|
3757
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3758
|
+
* months.
|
|
3759
|
+
*/
|
|
3760
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3761
|
+
/**
|
|
3762
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3763
|
+
*/
|
|
3764
|
+
conversion_rate?: number | null;
|
|
3765
|
+
/**
|
|
3766
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3767
|
+
*/
|
|
3768
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3769
|
+
/**
|
|
3770
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3771
|
+
*/
|
|
3772
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3773
|
+
/**
|
|
3774
|
+
* An alias for the price.
|
|
3775
|
+
*/
|
|
3776
|
+
external_price_id?: string | null;
|
|
3777
|
+
/**
|
|
3778
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3779
|
+
* applied.
|
|
3780
|
+
*/
|
|
3781
|
+
fixed_price_quantity?: number | null;
|
|
3782
|
+
/**
|
|
3783
|
+
* The property used to group this price on an invoice
|
|
3784
|
+
*/
|
|
3785
|
+
invoice_grouping_key?: string | null;
|
|
3786
|
+
/**
|
|
3787
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3788
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3789
|
+
*/
|
|
3790
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3791
|
+
/**
|
|
3792
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3793
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3794
|
+
* by setting `metadata` to `null`.
|
|
3795
|
+
*/
|
|
3796
|
+
metadata?: {
|
|
3797
|
+
[key: string]: string | null;
|
|
3798
|
+
} | null;
|
|
3799
|
+
}
|
|
3800
|
+
namespace NewFloatingPercentCompositePrice {
|
|
3801
|
+
/**
|
|
3802
|
+
* Configuration for percent pricing
|
|
3803
|
+
*/
|
|
3804
|
+
interface PercentConfig {
|
|
3805
|
+
/**
|
|
3806
|
+
* What percent of the component subtotals to charge
|
|
3807
|
+
*/
|
|
3808
|
+
percent: number;
|
|
3809
|
+
}
|
|
3810
|
+
}
|
|
3811
|
+
interface NewFloatingEventOutputPrice {
|
|
3812
|
+
/**
|
|
3813
|
+
* The cadence to bill for this price on.
|
|
3814
|
+
*/
|
|
3815
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3816
|
+
/**
|
|
3817
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
3818
|
+
*/
|
|
3819
|
+
currency: string;
|
|
3820
|
+
/**
|
|
3821
|
+
* Configuration for event_output pricing
|
|
3822
|
+
*/
|
|
3823
|
+
event_output_config: NewFloatingEventOutputPrice.EventOutputConfig;
|
|
3824
|
+
/**
|
|
3825
|
+
* The id of the item the price will be associated with.
|
|
3826
|
+
*/
|
|
3827
|
+
item_id: string;
|
|
3828
|
+
/**
|
|
3829
|
+
* The pricing model type
|
|
3830
|
+
*/
|
|
3831
|
+
model_type: 'event_output';
|
|
3832
|
+
/**
|
|
3833
|
+
* The name of the price.
|
|
3834
|
+
*/
|
|
3835
|
+
name: string;
|
|
3836
|
+
/**
|
|
3837
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3838
|
+
* usage-based.
|
|
3839
|
+
*/
|
|
3840
|
+
billable_metric_id?: string | null;
|
|
3841
|
+
/**
|
|
3842
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3843
|
+
* this is true, and in-arrears if this is false.
|
|
3844
|
+
*/
|
|
3845
|
+
billed_in_advance?: boolean | null;
|
|
3846
|
+
/**
|
|
3847
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3848
|
+
* months.
|
|
3849
|
+
*/
|
|
3850
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3851
|
+
/**
|
|
3852
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3853
|
+
*/
|
|
3854
|
+
conversion_rate?: number | null;
|
|
3855
|
+
/**
|
|
3856
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3857
|
+
*/
|
|
3858
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3859
|
+
/**
|
|
3860
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3861
|
+
*/
|
|
3862
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3863
|
+
/**
|
|
3864
|
+
* An alias for the price.
|
|
3865
|
+
*/
|
|
3866
|
+
external_price_id?: string | null;
|
|
3867
|
+
/**
|
|
3868
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3869
|
+
* applied.
|
|
3870
|
+
*/
|
|
3871
|
+
fixed_price_quantity?: number | null;
|
|
3872
|
+
/**
|
|
3873
|
+
* The property used to group this price on an invoice
|
|
3874
|
+
*/
|
|
3875
|
+
invoice_grouping_key?: string | null;
|
|
3876
|
+
/**
|
|
3877
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3878
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3879
|
+
*/
|
|
3880
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3881
|
+
/**
|
|
3882
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3883
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3884
|
+
* by setting `metadata` to `null`.
|
|
3885
|
+
*/
|
|
3886
|
+
metadata?: {
|
|
3887
|
+
[key: string]: string | null;
|
|
3888
|
+
} | null;
|
|
3889
|
+
}
|
|
3890
|
+
namespace NewFloatingEventOutputPrice {
|
|
3891
|
+
/**
|
|
3892
|
+
* Configuration for event_output pricing
|
|
3893
|
+
*/
|
|
3894
|
+
interface EventOutputConfig {
|
|
3895
|
+
/**
|
|
3896
|
+
* The key in the event data to extract the unit rate from.
|
|
3897
|
+
*/
|
|
3898
|
+
unit_rating_key: string;
|
|
3899
|
+
/**
|
|
3900
|
+
* An optional key in the event data to group by (e.g., event ID). All events will
|
|
3901
|
+
* also be grouped by their unit rate.
|
|
3902
|
+
*/
|
|
3903
|
+
grouping_key?: string | null;
|
|
3904
|
+
}
|
|
3905
|
+
}
|
|
3351
3906
|
}
|
|
3352
3907
|
}
|
|
3353
3908
|
export declare namespace Prices {
|