@openmeter/client 1.0.0-beta-faa46da9acfe → 1.0.0-beta-facf3b09ebaf
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/dist/index.d.ts +1 -1
- package/dist/models/schemas.d.ts +57 -5
- package/dist/models/schemas.js +25 -19
- package/dist/models/types.d.ts +21 -17
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -38,5 +38,5 @@ export type * from './models/operations/addons.js';
|
|
|
38
38
|
export type * from './models/operations/planAddons.js';
|
|
39
39
|
export type * from './models/operations/defaults.js';
|
|
40
40
|
export type * from './models/operations/governance.js';
|
|
41
|
-
export type { Labels, CursorPaginationQueryPage, SortQuery, IngestedEventValidationError, CursorMetaPage, BaseError, PageMeta, QueryFilterString, AppStripeCheckoutSessionCustomTextParams, AppStripeCreateCustomerPortalSessionOptions, CreateLabels, TaxConfigStripe, TaxConfigExternalInvoicing, FlatFeeDiscounts, PriceFree, WorkflowCollectionAlignmentSubscription,
|
|
41
|
+
export type { Labels, CursorPaginationQueryPage, SortQuery, IngestedEventValidationError, CursorMetaPage, BaseError, PageMeta, QueryFilterString, AppStripeCheckoutSessionCustomTextParams, AppStripeCreateCustomerPortalSessionOptions, CreateLabels, TaxConfigStripe, TaxConfigExternalInvoicing, FlatFeeDiscounts, PriceFree, WorkflowCollectionAlignmentSubscription, WorkflowPaymentChargeAutomaticallySettings, WorkflowPaymentSendInvoiceSettings, LlmCostProvider, LlmCostModel, RateCardStaticEntitlement, RateCardBooleanEntitlement, ProductCatalogValidationError, GovernanceQueryRequestCustomers, GovernanceQueryRequestFeatures, QueryFilterInteger, QueryFilterFloat, QueryFilterBoolean, PagePaginationQuery, PublicLabels, SystemAccountAccessToken, PersonalAccessToken, KonnectAccessToken, UpdateMeterRequest, AppCustomerDataStripe, AppCustomerDataExternalInvoicing, ListCostBasesParamsFilter, CurrencyAmount, PriceFlat, PriceUnit, RateCardDiscounts, Totals, FeatureManualUnitCost, FeatureLlmUnitCostPricing, LlmCostModelPricing, SpendCommitments, QueryFilterNumeric, CursorPaginationQuery, ListMetersParamsFilter, ListLlmCostPricesParamsFilter, LabelsFieldFilter, CustomerReference, ProfileReference, CreateResourceReference, TaxCodeReference, CreditGrantInvoiceReference, BillingCustomerReference, SubscriptionReference, AddonReference, AppReference, CurrencyFiat, FeatureReference, Event, MeterQueryRow, AppStripeCreateCustomerPortalSessionResult, ClosedPeriod, CostBasis, CreateCostBasisRequest, FeatureCostQueryRow, Resource, ResourceImmutable, QueryFilterDateTime, CursorMeta, InvalidParameterStandard, InvalidParameterMinimumLength, InvalidParameterMaximumLength, InvalidParameterChoiceItem, InvalidParameterDependentItem, Unauthorized, Forbidden, NotFound, Gone, Conflict, PayloadTooLarge, UnsupportedMediaType, UnprocessableContent, TooManyRequests, Internal, NotImplemented, NotAvailable, CreateCreditGrantFilters, CreditGrantFilters, UpsertPlanAddonRequest, ResourceWithKey, CreateMeterRequest, Meter, PaginatedMeta, QueryFilterStringMapItem, CustomerKeyReference, CustomerUsageAttribution, BillingAddress, Address, AppStripeCreateCheckoutSessionCustomerUpdate, AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement, AppStripeCreateCheckoutSessionTaxIdCollection, AppStripeCreateCheckoutSessionResult, CustomerStripeCreateCustomerPortalSessionRequest, EntitlementAccessResult, CreateCreditGrantPurchase, RecurringPeriod, RateCardMeteredEntitlement, CreditGrantPurchase, UpdateCreditGrantExternalSettlementRequest, ListCreditGrantsParamsFilter, GetCreditBalanceParamsFilter, ListChargesParamsFilter, ListPlansParamsFilter, SubscriptionCreate, RateCardProrationConfiguration, Subscription, AppCatalogItem, TaxCodeAppMapping, PartyTaxIdentity, WorkflowInvoicingSettings, ListCurrenciesParamsFilter, CurrencyCustom, CreateCurrencyCustomRequest, UnitConfig, GovernanceQueryRequest, GovernanceFeatureAccessReason, GovernanceQueryError, AppCustomerData, UpsertAppCustomerDataRequest, CreditAdjustment, CreditBalance, CreateCreditAdjustmentRequest, ListCreditTransactionsParamsFilter, CreditTransaction, PriceTier, ChargeTotals, FeatureLlmUnitCost, LlmCostPrice, LlmCostOverrideCreate, ListCustomersParamsFilter, ListSubscriptionsParamsFilter, ListFeatureParamsFilter, ListAddonsParamsFilter, CreateCreditGrantTaxConfig, CreditGrantTaxConfig, TaxConfig, RateCardTaxConfig, OrganizationDefaultTaxCodes, UpdateOrganizationDefaultTaxCodesRequest, SubscriptionAddon, PlanAddon, CreatePlanAddonRequest, ProfileAppReferences, ListEventsParamsFilter, ResourceFilters, FieldFilters, IngestedEvent, MeterQueryResult, FeatureCostQueryResult, MeterPagePaginatedResponse, CostBasisPagePaginatedResponse, MeterQueryFilters, FeatureMeterReference, CreateCustomerRequest, Customer, UpsertCustomerRequest, PartyAddresses, AppStripeCreateCheckoutSessionConsentCollection, ListCustomerEntitlementAccessResponseData, WorkflowCollectionAlignmentAnchored, SubscriptionPagePaginatedResponse, SubscriptionChangeResponse, SubscriptionCancel, SubscriptionChange, AppStripe, AppSandbox, AppExternalInvoicing, CreateTaxCodeRequest, TaxCode, UpsertTaxCodeRequest, InvoiceUsageQuantityDetail, GovernanceFeatureAccess, CustomerData, UpsertCustomerBillingDataRequest, CreditBalances, CreditTransactionPaginatedResponse, PriceGraduated, PriceVolume, PricePagePaginatedResponse, CreateCreditGrantRequest, CreditGrant, CreateFlatFeeChargeRequest, WorkflowTaxSettings, SubscriptionAddonPagePaginatedResponse, PlanAddonPagePaginatedResponse, IngestedEventPaginatedResponse, InvalidParameters, MeterQueryRequest, CustomerPagePaginatedResponse, Party, AppStripeCreateCheckoutSessionRequestOptions, TaxCodePagePaginatedResponse, CurrencyPagePaginatedResponse, GovernanceQueryResult, Feature, CreateFeatureRequest, UpdateFeatureRequest, CreditGrantPagePaginatedResponse, BadRequest, CustomerStripeCreateCheckoutSessionRequest, WorkflowCollectionSettings, AppPagePaginatedResponse, ProfileApps, GovernanceQueryResponse, FlatFeeCharge, UsageBasedCharge, CreateUsageBasedChargeRequest, RateCard, FeaturePagePaginatedResponse, Workflow, PlanPhase, Addon, CreateAddonRequest, UpsertAddonRequest, Profile, CreateBillingProfileRequest, UpsertBillingProfileRequest, ChargePagePaginatedResponse, Plan, CreatePlanRequest, UpsertPlanRequest, AddonPagePaginatedResponse, ProfilePagePaginatedResponse, PlanPagePaginatedResponse, SortQueryInput, BaseErrorInput, WorkflowPaymentSendInvoiceSettingsInput, EventInput, UnauthorizedInput, ForbiddenInput, NotFoundInput, GoneInput, ConflictInput, PayloadTooLargeInput, UnsupportedMediaTypeInput, UnprocessableContentInput, TooManyRequestsInput, InternalInput, NotImplementedInput, NotAvailableInput, AppStripeCreateCheckoutSessionCustomerUpdateInput, AppStripeCreateCheckoutSessionTaxIdCollectionInput, CreateCreditGrantPurchaseInput, RateCardMeteredEntitlementInput, CreditGrantPurchaseInput, WorkflowInvoicingSettingsInput, UnitConfigInput, GovernanceQueryRequestInput, IngestedEventInput, SubscriptionCancelInput, InvoiceUsageQuantityDetailInput, CreateCreditGrantRequestInput, CreditGrantInput, WorkflowTaxSettingsInput, IngestedEventPaginatedResponseInput, MeterQueryRequestInput, AppStripeCreateCheckoutSessionRequestOptionsInput, CreditGrantPagePaginatedResponseInput, BadRequestInput, CustomerStripeCreateCheckoutSessionRequestInput, WorkflowCollectionSettingsInput, RateCardInput, WorkflowInput, PlanPhaseInput, AddonInput, CreateAddonRequestInput, UpsertAddonRequestInput, ProfileInput, CreateBillingProfileRequestInput, UpsertBillingProfileRequestInput, PlanInput, CreatePlanRequestInput, UpsertPlanRequestInput, AddonPagePaginatedResponseInput, ProfilePagePaginatedResponseInput, PlanPagePaginatedResponseInput, } from './models/types.js';
|
|
42
42
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/models/schemas.d.ts
CHANGED
|
@@ -262,11 +262,10 @@ export declare const taxIdentificationCode: z.ZodString;
|
|
|
262
262
|
export declare const workflowCollectionAlignmentSubscription: z.ZodObject<{
|
|
263
263
|
type: z.ZodLiteral<"subscription">;
|
|
264
264
|
}, z.core.$strip>;
|
|
265
|
-
export declare const
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
}, z.core.$strip>;
|
|
265
|
+
export declare const workflowInvoicingSubscriptionEndProrationMode: z.ZodEnum<{
|
|
266
|
+
bill_full_period: "bill_full_period";
|
|
267
|
+
bill_actual_period: "bill_actual_period";
|
|
268
|
+
}>;
|
|
270
269
|
export declare const workflowPaymentChargeAutomaticallySettings: z.ZodObject<{
|
|
271
270
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
272
271
|
}, z.core.$strip>;
|
|
@@ -1267,6 +1266,15 @@ export declare const taxCodeAppMapping: z.ZodObject<{
|
|
|
1267
1266
|
export declare const partyTaxIdentity: z.ZodObject<{
|
|
1268
1267
|
code: z.ZodOptional<z.ZodString>;
|
|
1269
1268
|
}, z.core.$strip>;
|
|
1269
|
+
export declare const workflowInvoicingSettings: z.ZodObject<{
|
|
1270
|
+
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
1271
|
+
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
1272
|
+
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
1273
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
1274
|
+
bill_full_period: "bill_full_period";
|
|
1275
|
+
bill_actual_period: "bill_actual_period";
|
|
1276
|
+
}>>>;
|
|
1277
|
+
}, z.core.$strip>;
|
|
1270
1278
|
export declare const workflowPaymentSettings: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1271
1279
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
1272
1280
|
}, z.core.$strip>, z.ZodObject<{
|
|
@@ -4775,6 +4783,10 @@ export declare const workflow: z.ZodObject<{
|
|
|
4775
4783
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
4776
4784
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
4777
4785
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
4786
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
4787
|
+
bill_full_period: "bill_full_period";
|
|
4788
|
+
bill_actual_period: "bill_actual_period";
|
|
4789
|
+
}>>>;
|
|
4778
4790
|
}, z.core.$strip>>;
|
|
4779
4791
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
4780
4792
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -5648,6 +5660,10 @@ export declare const profile: z.ZodObject<{
|
|
|
5648
5660
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
5649
5661
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
5650
5662
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
5663
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
5664
|
+
bill_full_period: "bill_full_period";
|
|
5665
|
+
bill_actual_period: "bill_actual_period";
|
|
5666
|
+
}>>>;
|
|
5651
5667
|
}, z.core.$strip>>;
|
|
5652
5668
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
5653
5669
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -5729,6 +5745,10 @@ export declare const createBillingProfileRequest: z.ZodObject<{
|
|
|
5729
5745
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
5730
5746
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
5731
5747
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
5748
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
5749
|
+
bill_full_period: "bill_full_period";
|
|
5750
|
+
bill_actual_period: "bill_actual_period";
|
|
5751
|
+
}>>>;
|
|
5732
5752
|
}, z.core.$strip>>;
|
|
5733
5753
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
5734
5754
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -5810,6 +5830,10 @@ export declare const upsertBillingProfileRequest: z.ZodObject<{
|
|
|
5810
5830
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
5811
5831
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
5812
5832
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
5833
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
5834
|
+
bill_full_period: "bill_full_period";
|
|
5835
|
+
bill_actual_period: "bill_actual_period";
|
|
5836
|
+
}>>>;
|
|
5813
5837
|
}, z.core.$strip>>;
|
|
5814
5838
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
5815
5839
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -6609,6 +6633,10 @@ export declare const profilePagePaginatedResponse: z.ZodObject<{
|
|
|
6609
6633
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
6610
6634
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
6611
6635
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
6636
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
6637
|
+
bill_full_period: "bill_full_period";
|
|
6638
|
+
bill_actual_period: "bill_actual_period";
|
|
6639
|
+
}>>>;
|
|
6612
6640
|
}, z.core.$strip>>;
|
|
6613
6641
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
6614
6642
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -9163,6 +9191,10 @@ export declare const listBillingProfilesResponse: z.ZodObject<{
|
|
|
9163
9191
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9164
9192
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
9165
9193
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9194
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
9195
|
+
bill_full_period: "bill_full_period";
|
|
9196
|
+
bill_actual_period: "bill_actual_period";
|
|
9197
|
+
}>>>;
|
|
9166
9198
|
}, z.core.$strip>>;
|
|
9167
9199
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
9168
9200
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -9252,6 +9284,10 @@ export declare const createBillingProfileBody: z.ZodObject<{
|
|
|
9252
9284
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9253
9285
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
9254
9286
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9287
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
9288
|
+
bill_full_period: "bill_full_period";
|
|
9289
|
+
bill_actual_period: "bill_actual_period";
|
|
9290
|
+
}>>>;
|
|
9255
9291
|
}, z.core.$strip>>;
|
|
9256
9292
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
9257
9293
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -9337,6 +9373,10 @@ export declare const createBillingProfileResponse: z.ZodObject<{
|
|
|
9337
9373
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9338
9374
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
9339
9375
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9376
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
9377
|
+
bill_full_period: "bill_full_period";
|
|
9378
|
+
bill_actual_period: "bill_actual_period";
|
|
9379
|
+
}>>>;
|
|
9340
9380
|
}, z.core.$strip>>;
|
|
9341
9381
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
9342
9382
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -9425,6 +9465,10 @@ export declare const getBillingProfileResponse: z.ZodObject<{
|
|
|
9425
9465
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9426
9466
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
9427
9467
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9468
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
9469
|
+
bill_full_period: "bill_full_period";
|
|
9470
|
+
bill_actual_period: "bill_actual_period";
|
|
9471
|
+
}>>>;
|
|
9428
9472
|
}, z.core.$strip>>;
|
|
9429
9473
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
9430
9474
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -9509,6 +9553,10 @@ export declare const updateBillingProfileBody: z.ZodObject<{
|
|
|
9509
9553
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9510
9554
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
9511
9555
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9556
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
9557
|
+
bill_full_period: "bill_full_period";
|
|
9558
|
+
bill_actual_period: "bill_actual_period";
|
|
9559
|
+
}>>>;
|
|
9512
9560
|
}, z.core.$strip>>;
|
|
9513
9561
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
9514
9562
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
|
@@ -9583,6 +9631,10 @@ export declare const updateBillingProfileResponse: z.ZodObject<{
|
|
|
9583
9631
|
auto_advance: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9584
9632
|
draft_period: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
9585
9633
|
progressive_billing: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
9634
|
+
subscription_end_proration_mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
9635
|
+
bill_full_period: "bill_full_period";
|
|
9636
|
+
bill_actual_period: "bill_actual_period";
|
|
9637
|
+
}>>>;
|
|
9586
9638
|
}, z.core.$strip>>;
|
|
9587
9639
|
payment: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
9588
9640
|
collection_method: z.ZodLiteral<"charge_automatically">;
|
package/dist/models/schemas.js
CHANGED
|
@@ -485,25 +485,9 @@ export const workflowCollectionAlignmentSubscription = z
|
|
|
485
485
|
type: z.literal('subscription').describe('The type of alignment.'),
|
|
486
486
|
})
|
|
487
487
|
.describe('BillingWorkflowCollectionAlignmentSubscription specifies the alignment for collecting the pending line items into an invoice.');
|
|
488
|
-
export const
|
|
489
|
-
.
|
|
490
|
-
|
|
491
|
-
.boolean()
|
|
492
|
-
.optional()
|
|
493
|
-
.default(true)
|
|
494
|
-
.describe('Whether to automatically issue the invoice after the draftPeriod has passed.'),
|
|
495
|
-
draft_period: z
|
|
496
|
-
.string()
|
|
497
|
-
.optional()
|
|
498
|
-
.default('P0D')
|
|
499
|
-
.describe('The period for the invoice to be kept in draft status for manual reviews.'),
|
|
500
|
-
progressive_billing: z
|
|
501
|
-
.boolean()
|
|
502
|
-
.optional()
|
|
503
|
-
.default(true)
|
|
504
|
-
.describe('Should progressive billing be allowed for this workflow?'),
|
|
505
|
-
})
|
|
506
|
-
.describe('Invoice settings for a billing workflow.');
|
|
488
|
+
export const workflowInvoicingSubscriptionEndProrationMode = z
|
|
489
|
+
.enum(['bill_full_period', 'bill_actual_period'])
|
|
490
|
+
.describe('Billing workflow subscription end proration mode.');
|
|
507
491
|
export const workflowPaymentChargeAutomaticallySettings = z
|
|
508
492
|
.object({
|
|
509
493
|
collection_method: z
|
|
@@ -1836,6 +1820,28 @@ export const partyTaxIdentity = z
|
|
|
1836
1820
|
code: taxIdentificationCode.optional(),
|
|
1837
1821
|
})
|
|
1838
1822
|
.describe('Identity stores the details required to identify an entity for tax purposes in a specific country.');
|
|
1823
|
+
export const workflowInvoicingSettings = z
|
|
1824
|
+
.object({
|
|
1825
|
+
auto_advance: z
|
|
1826
|
+
.boolean()
|
|
1827
|
+
.optional()
|
|
1828
|
+
.default(true)
|
|
1829
|
+
.describe('Whether to automatically issue the invoice after the draftPeriod has passed.'),
|
|
1830
|
+
draft_period: z
|
|
1831
|
+
.string()
|
|
1832
|
+
.optional()
|
|
1833
|
+
.default('P0D')
|
|
1834
|
+
.describe('The period for the invoice to be kept in draft status for manual reviews.'),
|
|
1835
|
+
progressive_billing: z
|
|
1836
|
+
.boolean()
|
|
1837
|
+
.optional()
|
|
1838
|
+
.default(true)
|
|
1839
|
+
.describe('Should progressive billing be allowed for this workflow?'),
|
|
1840
|
+
subscription_end_proration_mode: workflowInvoicingSubscriptionEndProrationMode
|
|
1841
|
+
.optional()
|
|
1842
|
+
.default('bill_actual_period'),
|
|
1843
|
+
})
|
|
1844
|
+
.describe('Invoice settings for a billing workflow.');
|
|
1839
1845
|
export const workflowPaymentSettings = z
|
|
1840
1846
|
.discriminatedUnion('collection_method', [
|
|
1841
1847
|
workflowPaymentChargeAutomaticallySettings,
|
package/dist/models/types.d.ts
CHANGED
|
@@ -135,15 +135,6 @@ export interface WorkflowCollectionAlignmentSubscription {
|
|
|
135
135
|
/** The type of alignment. */
|
|
136
136
|
type: 'subscription';
|
|
137
137
|
}
|
|
138
|
-
/** Invoice settings for a billing workflow. */
|
|
139
|
-
export interface WorkflowInvoicingSettings {
|
|
140
|
-
/** Whether to automatically issue the invoice after the draftPeriod has passed. */
|
|
141
|
-
auto_advance: boolean;
|
|
142
|
-
/** The period for the invoice to be kept in draft status for manual reviews. */
|
|
143
|
-
draft_period: string;
|
|
144
|
-
/** Should progressive billing be allowed for this workflow? */
|
|
145
|
-
progressive_billing: boolean;
|
|
146
|
-
}
|
|
147
138
|
/** Payment settings for a billing workflow when the collection method is charge automatically. */
|
|
148
139
|
export interface WorkflowPaymentChargeAutomaticallySettings {
|
|
149
140
|
/** The collection method for the invoice. */
|
|
@@ -1243,6 +1234,17 @@ export interface PartyTaxIdentity {
|
|
|
1243
1234
|
/** Normalized tax identification code shown on the original identity document. */
|
|
1244
1235
|
code?: string;
|
|
1245
1236
|
}
|
|
1237
|
+
/** Invoice settings for a billing workflow. */
|
|
1238
|
+
export interface WorkflowInvoicingSettings {
|
|
1239
|
+
/** Whether to automatically issue the invoice after the draftPeriod has passed. */
|
|
1240
|
+
auto_advance: boolean;
|
|
1241
|
+
/** The period for the invoice to be kept in draft status for manual reviews. */
|
|
1242
|
+
draft_period: string;
|
|
1243
|
+
/** Should progressive billing be allowed for this workflow? */
|
|
1244
|
+
progressive_billing: boolean;
|
|
1245
|
+
/** Controls how subscription-ending shortened service periods are billed. */
|
|
1246
|
+
subscription_end_proration_mode: 'bill_full_period' | 'bill_actual_period';
|
|
1247
|
+
}
|
|
1246
1248
|
/** Filter options for listing currencies. */
|
|
1247
1249
|
export interface ListCurrenciesParamsFilter {
|
|
1248
1250
|
type?: 'fiat' | 'custom';
|
|
@@ -3012,14 +3014,6 @@ export interface BaseErrorInput {
|
|
|
3012
3014
|
instance: string;
|
|
3013
3015
|
[key: string]: unknown;
|
|
3014
3016
|
}
|
|
3015
|
-
export interface WorkflowInvoicingSettingsInput {
|
|
3016
|
-
/** Whether to automatically issue the invoice after the draftPeriod has passed. */
|
|
3017
|
-
auto_advance?: boolean;
|
|
3018
|
-
/** The period for the invoice to be kept in draft status for manual reviews. */
|
|
3019
|
-
draft_period?: string;
|
|
3020
|
-
/** Should progressive billing be allowed for this workflow? */
|
|
3021
|
-
progressive_billing?: boolean;
|
|
3022
|
-
}
|
|
3023
3017
|
export interface WorkflowPaymentSendInvoiceSettingsInput {
|
|
3024
3018
|
/** The collection method for the invoice. */
|
|
3025
3019
|
collection_method: 'send_invoice';
|
|
@@ -3114,6 +3108,16 @@ export interface CreditGrantPurchaseInput {
|
|
|
3114
3108
|
/** Current payment settlement status. */
|
|
3115
3109
|
settlement_status?: 'pending' | 'authorized' | 'settled';
|
|
3116
3110
|
}
|
|
3111
|
+
export interface WorkflowInvoicingSettingsInput {
|
|
3112
|
+
/** Whether to automatically issue the invoice after the draftPeriod has passed. */
|
|
3113
|
+
auto_advance?: boolean;
|
|
3114
|
+
/** The period for the invoice to be kept in draft status for manual reviews. */
|
|
3115
|
+
draft_period?: string;
|
|
3116
|
+
/** Should progressive billing be allowed for this workflow? */
|
|
3117
|
+
progressive_billing?: boolean;
|
|
3118
|
+
/** Controls how subscription-ending shortened service periods are billed. */
|
|
3119
|
+
subscription_end_proration_mode?: 'bill_full_period' | 'bill_actual_period';
|
|
3120
|
+
}
|
|
3117
3121
|
export interface UnitConfigInput {
|
|
3118
3122
|
/** The arithmetic operation to apply to the raw metered quantity. */
|
|
3119
3123
|
operation: 'divide' | 'multiply';
|