@openmeter/client 1.0.0-beta-b5069d91dadb → 1.0.0-beta-985183028366

package/dist/models/schemas.js

@@ -2763,12 +2763,12 @@ export const createChargeCostBasis = z
     createChargeCostBasisManual,
 ])
     .describe('Cost basis selection for a custom-currency charge. The variant chosen fixes when and how the conversion rate is determined.');
-export const createCreditGrantTaxConfig = z
+export const createTaxCodeConfig = z
     .object({
     behavior: taxBehavior.optional(),
-    taxCode: createResourceReference.optional(),
+    code: createResourceReference.optional(),
 })
-    .describe('Tax configuration for a credit grant. Tax configuration should be provided to ensure correct revenue recognition, including for externally funded grants.');
+    .describe('Tax configuration for a billable resource. Applies a tax code and tax behavior to the resulting invoice line items. When not set, the applicable default is used: the billing profile default tax configuration, then the organization default tax code.');
 export const chargeCostBasis = z
     .discriminatedUnion('type', [
     chargeCostBasisDynamic,
@@ -2776,18 +2776,12 @@ export const chargeCostBasis = z
     chargeCostBasisManual,
 ])
     .describe('Cost basis selection for a custom-currency charge. The variant chosen fixes when and how the conversion rate is determined.');
-export const creditGrantTaxConfig = z
+export const taxCodeConfig = z
     .object({
     behavior: taxBehavior.optional(),
-    taxCode: taxCodeReference.optional(),
-})
-    .describe('Tax configuration for a credit grant. Tax configuration should be provided to ensure correct revenue recognition, including for externally funded grants.');
-export const rateCardTaxConfig = z
-    .object({
-    behavior: taxBehavior.optional(),
-    code: taxCodeReference,
+    code: taxCodeReference.optional(),
 })
-    .describe('The tax config of the rate card.');
+    .describe('Tax configuration for a billable resource. Applies a tax code and tax behavior to the resulting invoice line items. When not set, the applicable default is used: the billing profile default tax configuration, then the organization default tax code.');
 export const taxConfig = z
     .object({
     behavior: taxBehavior.optional(),
@@ -2879,12 +2873,12 @@ export const createPlanAddonRequest = z
         .describe('The maximum number of times the add-on can be purchased for the plan. For single-instance add-ons this field must be omitted. For multi-instance add-ons when omitted, unlimited quantity can be purchased.'),
 })
     .describe('PlanAddon create request.');
-export const updateRateCardTaxConfig = z
+export const updateTaxCodeConfig = z
     .object({
     behavior: taxBehavior.optional(),
-    code: updateResourceReference,
+    code: updateResourceReference.optional(),
 })
-    .describe('The tax config of the rate card.');
+    .describe('Tax configuration for a billable resource. Applies a tax code and tax behavior to the resulting invoice line items. When not set, the applicable default is used: the billing profile default tax configuration, then the organization default tax code.');
 export const listEventsParamsFilter = z
     .object({
     id: stringFieldFilter.optional(),
@@ -4068,7 +4062,7 @@ export const createCreditGrantRequest = z
     currency: createCurrencyCode,
     amount: numeric,
     purchase: createCreditGrantPurchase.optional(),
-    taxConfig: createCreditGrantTaxConfig.optional(),
+    taxConfig: createTaxCodeConfig.optional(),
     filters: createCreditGrantFilters.optional(),
     priority: z
         .number()
@@ -4104,7 +4098,7 @@ export const creditGrant = z
     currency: billingCurrencyCode,
     amount: numeric,
     purchase: creditGrantPurchase.optional(),
-    taxConfig: creditGrantTaxConfig.optional(),
+    taxConfig: taxCodeConfig.optional(),
     invoice: creditGrantInvoiceReference.optional(),
     filters: creditGrantFilters.optional(),
     priority: z
@@ -4258,14 +4252,14 @@ export const rateCard = z
     paymentTerm: pricePaymentTerm.optional().default('in_arrears'),
     commitments: spendCommitments.optional(),
     discounts: rateCardDiscounts.optional(),
-    taxConfig: rateCardTaxConfig.optional(),
+    taxConfig: taxCodeConfig.optional(),
     entitlement: rateCardEntitlement.optional(),
 })
     .describe('A rate card defines the pricing and entitlement of a feature or service.');
 export const invoiceLineRateCard = z
     .object({
     price: price,
-    taxConfig: rateCardTaxConfig.optional(),
+    taxConfig: taxCodeConfig.optional(),
     featureKey: resourceKey.optional(),
     discounts: rateCardDiscounts.optional(),
     unitConfig: unitConfig.optional(),
@@ -4340,7 +4334,7 @@ export const featurePagePaginatedResponse = z
 export const updateInvoiceLineRateCard = z
     .object({
     price: updatePrice,
-    taxConfig: updateRateCardTaxConfig.optional(),
+    taxConfig: updateTaxCodeConfig.optional(),
     featureKey: resourceKey.optional(),
     discounts: updateDiscounts.optional(),
 })
@@ -8692,12 +8686,12 @@ export const createChargeCostBasisWire = z
     createChargeCostBasisManualWire,
 ])
     .describe('Cost basis selection for a custom-currency charge. The variant chosen fixes when and how the conversion rate is determined.');
-export const createCreditGrantTaxConfigWire = z
+export const createTaxCodeConfigWire = z
     .strictObject({
     behavior: taxBehaviorWire.optional(),
-    tax_code: createResourceReferenceWire.optional(),
+    code: createResourceReferenceWire.optional(),
 })
-    .describe('Tax configuration for a credit grant. Tax configuration should be provided to ensure correct revenue recognition, including for externally funded grants.');
+    .describe('Tax configuration for a billable resource. Applies a tax code and tax behavior to the resulting invoice line items. When not set, the applicable default is used: the billing profile default tax configuration, then the organization default tax code.');
 export const chargeCostBasisWire = z
     .discriminatedUnion('type', [
     chargeCostBasisDynamicWire,
@@ -8705,18 +8699,12 @@ export const chargeCostBasisWire = z
     chargeCostBasisManualWire,
 ])
     .describe('Cost basis selection for a custom-currency charge. The variant chosen fixes when and how the conversion rate is determined.');
-export const creditGrantTaxConfigWire = z
-    .strictObject({
-    behavior: taxBehaviorWire.optional(),
-    tax_code: taxCodeReferenceWire.optional(),
-})
-    .describe('Tax configuration for a credit grant. Tax configuration should be provided to ensure correct revenue recognition, including for externally funded grants.');
-export const rateCardTaxConfigWire = z
+export const taxCodeConfigWire = z
     .strictObject({
     behavior: taxBehaviorWire.optional(),
-    code: taxCodeReferenceWire,
+    code: taxCodeReferenceWire.optional(),
 })
-    .describe('The tax config of the rate card.');
+    .describe('Tax configuration for a billable resource. Applies a tax code and tax behavior to the resulting invoice line items. When not set, the applicable default is used: the billing profile default tax configuration, then the organization default tax code.');
 export const taxConfigWire = z
     .strictObject({
     behavior: taxBehaviorWire.optional(),
@@ -8808,12 +8796,12 @@ export const createPlanAddonRequestWire = z
         .describe('The maximum number of times the add-on can be purchased for the plan. For single-instance add-ons this field must be omitted. For multi-instance add-ons when omitted, unlimited quantity can be purchased.'),
 })
     .describe('PlanAddon create request.');
-export const updateRateCardTaxConfigWire = z
+export const updateTaxCodeConfigWire = z
     .strictObject({
     behavior: taxBehaviorWire.optional(),
-    code: updateResourceReferenceWire,
+    code: updateResourceReferenceWire.optional(),
 })
-    .describe('The tax config of the rate card.');
+    .describe('Tax configuration for a billable resource. Applies a tax code and tax behavior to the resulting invoice line items. When not set, the applicable default is used: the billing profile default tax configuration, then the organization default tax code.');
 export const listEventsParamsFilterWire = z
     .strictObject({
     id: stringFieldFilterWire.optional(),
@@ -9999,7 +9987,7 @@ export const createCreditGrantRequestWire = z
     currency: createCurrencyCodeWire,
     amount: numericWire,
     purchase: createCreditGrantPurchaseWire.optional(),
-    tax_config: createCreditGrantTaxConfigWire.optional(),
+    tax_config: createTaxCodeConfigWire.optional(),
     filters: createCreditGrantFiltersWire.optional(),
     priority: z
         .number()
@@ -10034,7 +10022,7 @@ export const creditGrantWire = z
     currency: billingCurrencyCodeWire,
     amount: numericWire,
     purchase: creditGrantPurchaseWire.optional(),
-    tax_config: creditGrantTaxConfigWire.optional(),
+    tax_config: taxCodeConfigWire.optional(),
     invoice: creditGrantInvoiceReferenceWire.optional(),
     filters: creditGrantFiltersWire.optional(),
     priority: z
@@ -10188,14 +10176,14 @@ export const rateCardWire = z
     payment_term: pricePaymentTermWire.optional(),
     commitments: spendCommitmentsWire.optional(),
     discounts: rateCardDiscountsWire.optional(),
-    tax_config: rateCardTaxConfigWire.optional(),
+    tax_config: taxCodeConfigWire.optional(),
     entitlement: rateCardEntitlementWire.optional(),
 })
     .describe('A rate card defines the pricing and entitlement of a feature or service.');
 export const invoiceLineRateCardWire = z
     .strictObject({
     price: priceWire,
-    tax_config: rateCardTaxConfigWire.optional(),
+    tax_config: taxCodeConfigWire.optional(),
     feature_key: resourceKeyWire.optional(),
     discounts: rateCardDiscountsWire.optional(),
     unit_config: unitConfigWire.optional(),
@@ -10270,7 +10258,7 @@ export const featurePagePaginatedResponseWire = z
 export const updateInvoiceLineRateCardWire = z
     .strictObject({
     price: updatePriceWire,
-    tax_config: updateRateCardTaxConfigWire.optional(),
+    tax_config: updateTaxCodeConfigWire.optional(),
     feature_key: resourceKeyWire.optional(),
     discounts: updateDiscountsWire.optional(),
 })

package/dist/models/types.d.ts

@@ -2581,33 +2581,44 @@ export interface ListPlanAddonsParamsFilter {
     planCurrency?: StringFieldFilter;
 }
 /**
- * Tax configuration for a credit grant.
+ * Tax configuration for a billable resource.
  *
- * Tax configuration should be provided to ensure correct revenue recognition,
- * including for externally funded grants.
+ * Applies a tax code and tax behavior to the resulting invoice line items. When
+ * not set, the applicable default is used: the billing profile default tax
+ * configuration, then the organization default tax code.
  */
-export interface CreateCreditGrantTaxConfig {
-    /** Tax behavior applied to the invoice line item. */
+export interface CreateTaxCodeConfig {
+    /**
+     * Tax behavior.
+     *
+     * This enum is used to specify whether tax is included in the price or excluded
+     * from the price. If not specified, the billing profile is used to determine the
+     * tax behavior. If not specified in the billing profile, the provider's default
+     * behavior is used.
+     */
     behavior?: 'inclusive' | 'exclusive';
     /** Tax code applied to the invoice line item. */
-    taxCode?: CreateResourceReference;
+    code?: CreateResourceReference;
 }
 /**
- * Tax configuration for a credit grant.
+ * Tax configuration for a billable resource.
  *
- * Tax configuration should be provided to ensure correct revenue recognition,
- * including for externally funded grants.
+ * Applies a tax code and tax behavior to the resulting invoice line items. When
+ * not set, the applicable default is used: the billing profile default tax
+ * configuration, then the organization default tax code.
  */
-export interface CreditGrantTaxConfig {
-    /** Tax behavior applied to the invoice line item. */
+export interface TaxCodeConfig {
+    /**
+     * Tax behavior.
+     *
+     * This enum is used to specify whether tax is included in the price or excluded
+     * from the price. If not specified, the billing profile is used to determine the
+     * tax behavior. If not specified in the billing profile, the provider's default
+     * behavior is used.
+     */
     behavior?: 'inclusive' | 'exclusive';
     /** Tax code applied to the invoice line item. */
-    taxCode?: TaxCodeReference;
-}
-/** The tax config of the rate card. */
-export interface RateCardTaxConfig {
-    behavior?: 'inclusive' | 'exclusive';
-    code: TaxCodeReference;
+    code?: TaxCodeReference;
 }
 /** Set of provider specific tax configs. */
 export interface TaxConfig {
@@ -2741,10 +2752,25 @@ export interface CreatePlanAddonRequest {
      */
     maxQuantity?: number;
 }
-/** The tax config of the rate card. */
-export interface UpdateRateCardTaxConfig {
+/**
+ * Tax configuration for a billable resource.
+ *
+ * Applies a tax code and tax behavior to the resulting invoice line items. When
+ * not set, the applicable default is used: the billing profile default tax
+ * configuration, then the organization default tax code.
+ */
+export interface UpdateTaxCodeConfig {
+    /**
+     * Tax behavior.
+     *
+     * This enum is used to specify whether tax is included in the price or excluded
+     * from the price. If not specified, the billing profile is used to determine the
+     * tax behavior. If not specified in the billing profile, the provider's default
+     * behavior is used.
+     */
     behavior?: 'inclusive' | 'exclusive';
-    code: UpdateResourceReference;
+    /** Tax code applied to the invoice line item. */
+    code?: UpdateResourceReference;
 }
 /** Filter options for listing ingested events. */
 export interface ListEventsParamsFilter {
@@ -4428,7 +4454,7 @@ export interface CreateCreditGrantRequest {
      * credit grant tax code is applied, if that's not set the global default taxcode
      * is used.
      */
-    taxConfig?: CreateCreditGrantTaxConfig;
+    taxConfig?: CreateTaxCodeConfig;
     filters?: CreateCreditGrantFilters;
     /** Draw-down priority of the grant. Lower values have higher priority. */
     priority: number;
@@ -4501,7 +4527,7 @@ export interface CreditGrant {
      * credit grant tax code is applied, if that's not set the global default taxcode
      * is used.
      */
-    taxConfig?: CreditGrantTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /** Available when `funding_method` is `invoice`. */
     invoice?: CreditGrantInvoiceReference;
     filters?: CreditGrantFilters;
@@ -4775,7 +4801,7 @@ export interface RateCard {
     /** The discounts of the rate card. */
     discounts?: RateCardDiscounts;
     /** The tax config of the rate card. */
-    taxConfig?: RateCardTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /**
      * The entitlement template granted to subscribers of a plan or addon containing
      * this rate card. Requires `feature` to be set.
@@ -4787,7 +4813,7 @@ export interface InvoiceLineRateCard {
     /** The price definition used to calculate charges for this line. */
     price: Price;
     /** Tax configuration snapshot for this line. */
-    taxConfig?: RateCardTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /** The feature key associated with this line's rate card. */
     featureKey?: string;
     /** Discount configuration from the rate card. */
@@ -4927,7 +4953,7 @@ export interface UpdateInvoiceLineRateCard {
     /** The price definition used to calculate charges for this line. */
     price: UpdatePrice;
     /** Tax configuration snapshot for this line. */
-    taxConfig?: UpdateRateCardTaxConfig;
+    taxConfig?: UpdateTaxCodeConfig;
     /** The feature key associated with this line's rate card. */
     featureKey?: string;
     /** Discount configuration from the rate card. */
@@ -7238,7 +7264,7 @@ export interface CreateCreditGrantRequestInput {
      * credit grant tax code is applied, if that's not set the global default taxcode
      * is used.
      */
-    taxConfig?: CreateCreditGrantTaxConfig;
+    taxConfig?: CreateTaxCodeConfig;
     filters?: CreateCreditGrantFilters;
     /** Draw-down priority of the grant. Lower values have higher priority. */
     priority?: number;
@@ -7311,7 +7337,7 @@ export interface CreditGrantInput {
      * credit grant tax code is applied, if that's not set the global default taxcode
      * is used.
      */
-    taxConfig?: CreditGrantTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /** Available when `funding_method` is `invoice`. */
     invoice?: CreditGrantInvoiceReference;
     filters?: CreditGrantFilters;
@@ -7517,7 +7543,7 @@ export interface RateCardInput {
     /** The discounts of the rate card. */
     discounts?: RateCardDiscounts;
     /** The tax config of the rate card. */
-    taxConfig?: RateCardTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /**
      * The entitlement template granted to subscribers of a plan or addon containing
      * this rate card. Requires `feature` to be set.
@@ -7529,7 +7555,7 @@ export interface InvoiceLineRateCardInput {
     /** The price definition used to calculate charges for this line. */
     price: Price;
     /** Tax configuration snapshot for this line. */
-    taxConfig?: RateCardTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /** The feature key associated with this line's rate card. */
     featureKey?: string;
     /** Discount configuration from the rate card. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/client",
-  "version": "1.0.0-beta-b5069d91dadb",
+  "version": "1.0.0-beta-985183028366",
   "description": "Official TypeScript SDK for the OpenMeter API — usage metering and billing",
   "keywords": [
     "openmeter",