Skip to content

Commit 9e9ba52

Browse files
feat(api): api update
1 parent bf101c9 commit 9e9ba52

File tree

7 files changed

+1598
-38
lines changed

7 files changed

+1598
-38
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 118
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-297c7ce95bc0aa1ac6f324a487515f49b8a30b74eb9d39ca9dcd2d9cf065f0ef.yml
3-
openapi_spec_hash: 29e9af981bc78379336079bb4208c54d
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-b070c1d97a6e3b400f43d2bce36c22ed89d432345b26374728c55dd0a20f0afa.yml
3+
openapi_spec_hash: dba4ff52c381cda6159fc56d8b77eb32
44
config_hash: 1f73a949b649ecfe6ec68ba1bb459dc2

src/resources/beta/beta.ts

Lines changed: 228 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ export namespace BetaCreatePlanVersionParams {
208208
| Shared.NewPlanScalableMatrixWithTieredPricingPrice
209209
| Shared.NewPlanCumulativeGroupedBulkPrice
210210
| Shared.NewPlanMinimumCompositePrice
211+
| AddPrice.NewPlanPercentCompositePrice
211212
| AddPrice.NewPlanEventOutputPrice
212213
| null;
213214
}
@@ -472,6 +473,119 @@ export namespace BetaCreatePlanVersionParams {
472473
}
473474
}
474475

476+
export interface NewPlanPercentCompositePrice {
477+
/**
478+
* The cadence to bill for this price on.
479+
*/
480+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
481+
482+
/**
483+
* The id of the item the price will be associated with.
484+
*/
485+
item_id: string;
486+
487+
/**
488+
* The pricing model type
489+
*/
490+
model_type: 'percent';
491+
492+
/**
493+
* The name of the price.
494+
*/
495+
name: string;
496+
497+
/**
498+
* Configuration for percent pricing
499+
*/
500+
percent_config: NewPlanPercentCompositePrice.PercentConfig;
501+
502+
/**
503+
* The id of the billable metric for the price. Only needed if the price is
504+
* usage-based.
505+
*/
506+
billable_metric_id?: string | null;
507+
508+
/**
509+
* If the Price represents a fixed cost, the price will be billed in-advance if
510+
* this is true, and in-arrears if this is false.
511+
*/
512+
billed_in_advance?: boolean | null;
513+
514+
/**
515+
* For custom cadence: specifies the duration of the billing period in days or
516+
* months.
517+
*/
518+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
519+
520+
/**
521+
* The per unit conversion rate of the price currency to the invoicing currency.
522+
*/
523+
conversion_rate?: number | null;
524+
525+
/**
526+
* The configuration for the rate of the price currency to the invoicing currency.
527+
*/
528+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
529+
530+
/**
531+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
532+
* price is billed.
533+
*/
534+
currency?: string | null;
535+
536+
/**
537+
* For dimensional price: specifies a price group and dimension values
538+
*/
539+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
540+
541+
/**
542+
* An alias for the price.
543+
*/
544+
external_price_id?: string | null;
545+
546+
/**
547+
* If the Price represents a fixed cost, this represents the quantity of units
548+
* applied.
549+
*/
550+
fixed_price_quantity?: number | null;
551+
552+
/**
553+
* The property used to group this price on an invoice
554+
*/
555+
invoice_grouping_key?: string | null;
556+
557+
/**
558+
* Within each billing cycle, specifies the cadence at which invoices are produced.
559+
* If unspecified, a single invoice is produced per billing cycle.
560+
*/
561+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
562+
563+
/**
564+
* User-specified key/value pairs for the resource. Individual keys can be removed
565+
* by setting the value to `null`, and the entire metadata mapping can be cleared
566+
* by setting `metadata` to `null`.
567+
*/
568+
metadata?: { [key: string]: string | null } | null;
569+
570+
/**
571+
* A transient ID that can be used to reference this price when adding adjustments
572+
* in the same API call.
573+
*/
574+
reference_id?: string | null;
575+
}
576+
577+
export namespace NewPlanPercentCompositePrice {
578+
/**
579+
* Configuration for percent pricing
580+
*/
581+
export interface PercentConfig {
582+
/**
583+
* What percent of the component subtotals to charge
584+
*/
585+
percent: number;
586+
}
587+
}
588+
475589
export interface NewPlanEventOutputPrice {
476590
/**
477591
* The cadence to bill for this price on.
@@ -685,6 +799,7 @@ export namespace BetaCreatePlanVersionParams {
685799
| Shared.NewPlanScalableMatrixWithTieredPricingPrice
686800
| Shared.NewPlanCumulativeGroupedBulkPrice
687801
| Shared.NewPlanMinimumCompositePrice
802+
| ReplacePrice.NewPlanPercentCompositePrice
688803
| ReplacePrice.NewPlanEventOutputPrice
689804
| null;
690805
}
@@ -949,6 +1064,119 @@ export namespace BetaCreatePlanVersionParams {
9491064
}
9501065
}
9511066

1067+
export interface NewPlanPercentCompositePrice {
1068+
/**
1069+
* The cadence to bill for this price on.
1070+
*/
1071+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1072+
1073+
/**
1074+
* The id of the item the price will be associated with.
1075+
*/
1076+
item_id: string;
1077+
1078+
/**
1079+
* The pricing model type
1080+
*/
1081+
model_type: 'percent';
1082+
1083+
/**
1084+
* The name of the price.
1085+
*/
1086+
name: string;
1087+
1088+
/**
1089+
* Configuration for percent pricing
1090+
*/
1091+
percent_config: NewPlanPercentCompositePrice.PercentConfig;
1092+
1093+
/**
1094+
* The id of the billable metric for the price. Only needed if the price is
1095+
* usage-based.
1096+
*/
1097+
billable_metric_id?: string | null;
1098+
1099+
/**
1100+
* If the Price represents a fixed cost, the price will be billed in-advance if
1101+
* this is true, and in-arrears if this is false.
1102+
*/
1103+
billed_in_advance?: boolean | null;
1104+
1105+
/**
1106+
* For custom cadence: specifies the duration of the billing period in days or
1107+
* months.
1108+
*/
1109+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1110+
1111+
/**
1112+
* The per unit conversion rate of the price currency to the invoicing currency.
1113+
*/
1114+
conversion_rate?: number | null;
1115+
1116+
/**
1117+
* The configuration for the rate of the price currency to the invoicing currency.
1118+
*/
1119+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
1120+
1121+
/**
1122+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
1123+
* price is billed.
1124+
*/
1125+
currency?: string | null;
1126+
1127+
/**
1128+
* For dimensional price: specifies a price group and dimension values
1129+
*/
1130+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
1131+
1132+
/**
1133+
* An alias for the price.
1134+
*/
1135+
external_price_id?: string | null;
1136+
1137+
/**
1138+
* If the Price represents a fixed cost, this represents the quantity of units
1139+
* applied.
1140+
*/
1141+
fixed_price_quantity?: number | null;
1142+
1143+
/**
1144+
* The property used to group this price on an invoice
1145+
*/
1146+
invoice_grouping_key?: string | null;
1147+
1148+
/**
1149+
* Within each billing cycle, specifies the cadence at which invoices are produced.
1150+
* If unspecified, a single invoice is produced per billing cycle.
1151+
*/
1152+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1153+
1154+
/**
1155+
* User-specified key/value pairs for the resource. Individual keys can be removed
1156+
* by setting the value to `null`, and the entire metadata mapping can be cleared
1157+
* by setting `metadata` to `null`.
1158+
*/
1159+
metadata?: { [key: string]: string | null } | null;
1160+
1161+
/**
1162+
* A transient ID that can be used to reference this price when adding adjustments
1163+
* in the same API call.
1164+
*/
1165+
reference_id?: string | null;
1166+
}
1167+
1168+
export namespace NewPlanPercentCompositePrice {
1169+
/**
1170+
* Configuration for percent pricing
1171+
*/
1172+
export interface PercentConfig {
1173+
/**
1174+
* What percent of the component subtotals to charge
1175+
*/
1176+
percent: number;
1177+
}
1178+
}
1179+
9521180
export interface NewPlanEventOutputPrice {
9531181
/**
9541182
* The cadence to bill for this price on.

0 commit comments

Comments
 (0)