orb-billing 4.47.4 → 4.49.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 +21 -0
- package/index.d.mts +5 -5
- package/index.d.ts +5 -5
- package/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/plans/plans.d.ts +95 -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 +169 -2
- 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/subscriptions.d.ts +96 -2
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/index.ts +5 -5
- package/src/resources/plans/plans.ts +114 -0
- package/src/resources/prices/prices.ts +225 -1
- package/src/resources/subscriptions.ts +115 -1
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -13446,7 +13446,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
13446
13446
|
/**
|
|
13447
13447
|
* The definition of a new price to create and add to the subscription.
|
|
13448
13448
|
*/
|
|
13449
|
-
price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingGroupedTieredPrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingMatrixWithDisplayNamePrice | Add.NewFloatingBulkWithProrationPrice | Add.NewFloatingGroupedTieredPackagePrice | null;
|
|
13449
|
+
price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingGroupedTieredPrice | Add.NewFloatingMaxGroupTieredPrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingMatrixWithDisplayNamePrice | Add.NewFloatingBulkWithProrationPrice | Add.NewFloatingGroupedTieredPackagePrice | null;
|
|
13450
13450
|
/**
|
|
13451
13451
|
* The id of the price to add to the subscription.
|
|
13452
13452
|
*/
|
|
@@ -14802,6 +14802,99 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
14802
14802
|
duration_unit: 'day' | 'month';
|
|
14803
14803
|
}
|
|
14804
14804
|
}
|
|
14805
|
+
interface NewFloatingMaxGroupTieredPrice {
|
|
14806
|
+
/**
|
|
14807
|
+
* The cadence to bill for this price on.
|
|
14808
|
+
*/
|
|
14809
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
14810
|
+
/**
|
|
14811
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
14812
|
+
*/
|
|
14813
|
+
currency: string;
|
|
14814
|
+
/**
|
|
14815
|
+
* The id of the item the plan will be associated with.
|
|
14816
|
+
*/
|
|
14817
|
+
item_id: string;
|
|
14818
|
+
max_group_tiered_config: Record<string, unknown>;
|
|
14819
|
+
model_type: 'max_group_tiered';
|
|
14820
|
+
/**
|
|
14821
|
+
* The name of the price.
|
|
14822
|
+
*/
|
|
14823
|
+
name: string;
|
|
14824
|
+
/**
|
|
14825
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
14826
|
+
* usage-based.
|
|
14827
|
+
*/
|
|
14828
|
+
billable_metric_id?: string | null;
|
|
14829
|
+
/**
|
|
14830
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
14831
|
+
* this is true, and in-arrears if this is false.
|
|
14832
|
+
*/
|
|
14833
|
+
billed_in_advance?: boolean | null;
|
|
14834
|
+
/**
|
|
14835
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
14836
|
+
* months.
|
|
14837
|
+
*/
|
|
14838
|
+
billing_cycle_configuration?: NewFloatingMaxGroupTieredPrice.BillingCycleConfiguration | null;
|
|
14839
|
+
/**
|
|
14840
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
14841
|
+
*/
|
|
14842
|
+
conversion_rate?: number | null;
|
|
14843
|
+
/**
|
|
14844
|
+
* An alias for the price.
|
|
14845
|
+
*/
|
|
14846
|
+
external_price_id?: string | null;
|
|
14847
|
+
/**
|
|
14848
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
14849
|
+
* applied.
|
|
14850
|
+
*/
|
|
14851
|
+
fixed_price_quantity?: number | null;
|
|
14852
|
+
/**
|
|
14853
|
+
* The property used to group this price on an invoice
|
|
14854
|
+
*/
|
|
14855
|
+
invoice_grouping_key?: string | null;
|
|
14856
|
+
/**
|
|
14857
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
14858
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
14859
|
+
*/
|
|
14860
|
+
invoicing_cycle_configuration?: NewFloatingMaxGroupTieredPrice.InvoicingCycleConfiguration | null;
|
|
14861
|
+
/**
|
|
14862
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
14863
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
14864
|
+
* by setting `metadata` to `null`.
|
|
14865
|
+
*/
|
|
14866
|
+
metadata?: Record<string, string | null> | null;
|
|
14867
|
+
}
|
|
14868
|
+
namespace NewFloatingMaxGroupTieredPrice {
|
|
14869
|
+
/**
|
|
14870
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
14871
|
+
* months.
|
|
14872
|
+
*/
|
|
14873
|
+
interface BillingCycleConfiguration {
|
|
14874
|
+
/**
|
|
14875
|
+
* The duration of the billing period.
|
|
14876
|
+
*/
|
|
14877
|
+
duration: number;
|
|
14878
|
+
/**
|
|
14879
|
+
* The unit of billing period duration.
|
|
14880
|
+
*/
|
|
14881
|
+
duration_unit: 'day' | 'month';
|
|
14882
|
+
}
|
|
14883
|
+
/**
|
|
14884
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
14885
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
14886
|
+
*/
|
|
14887
|
+
interface InvoicingCycleConfiguration {
|
|
14888
|
+
/**
|
|
14889
|
+
* The duration of the billing period.
|
|
14890
|
+
*/
|
|
14891
|
+
duration: number;
|
|
14892
|
+
/**
|
|
14893
|
+
* The unit of billing period duration.
|
|
14894
|
+
*/
|
|
14895
|
+
duration_unit: 'day' | 'month';
|
|
14896
|
+
}
|
|
14897
|
+
}
|
|
14805
14898
|
interface NewFloatingTieredWithMinimumPrice {
|
|
14806
14899
|
/**
|
|
14807
14900
|
* The cadence to bill for this price on.
|
|
@@ -16095,7 +16188,8 @@ export interface SubscriptionSchedulePlanChangeParams {
|
|
|
16095
16188
|
billing_cycle_anchor_configuration?: SubscriptionSchedulePlanChangeParams.BillingCycleAnchorConfiguration | null;
|
|
16096
16189
|
/**
|
|
16097
16190
|
* The date that the plan change should take effect. This parameter can only be
|
|
16098
|
-
* passed if the `change_option` is `requested_date`.
|
|
16191
|
+
* passed if the `change_option` is `requested_date`. If a date with no time is
|
|
16192
|
+
* passed, the plan change will happen at midnight in the customer's timezone.
|
|
16099
16193
|
*/
|
|
16100
16194
|
change_date?: string | null;
|
|
16101
16195
|
/**
|