@openmeter/client 1.0.0-beta-8f93b11ab8cd → 1.0.0-beta-52bb0a888f9a

package/dist/models/types.d.ts

@@ -508,6 +508,13 @@ export interface AppCustomerDataExternalInvoicing {
     /** Labels for this external invoicing integration on the customer. */
     labels?: Labels;
 }
+/** Cost basis resolved at the charge's full service period start. */
+export interface ChargeCostBasisDynamic {
+    /** Discriminator selecting the cost basis mode. */
+    type: 'dynamic';
+    /** The fiat currency the charge amount is converted into for invoicing. */
+    fiatCurrency: string;
+}
 /** Currency describes a currency supported by the billing system. */
 export interface CurrencyFiat {
     /** The type of the currency. */
@@ -615,6 +622,15 @@ export interface RateCardDiscounts {
      */
     usage?: string;
 }
+/** Cost basis with an explicit conversion rate supplied with the charge. */
+export interface ChargeCostBasisManual {
+    /** Discriminator selecting the cost basis mode. */
+    type: 'manual';
+    /** The fiat currency the charge amount is converted into for invoicing. */
+    fiatCurrency: string;
+    /** Fiat amount per one unit of the custom currency. */
+    rate: string;
+}
 /** Totals contains the summaries of all calculations for a billing resource. */
 export interface Totals {
     /** The total value of the resource before taxes, discounts and commitments. */
@@ -680,11 +696,6 @@ export interface FeatureLlmUnitCostPricing {
     /** Cost per cache write token in USD. */
     cacheWritePerToken?: string;
 }
-/** Monetary amount in a specific currency. */
-export interface CurrencyAmount {
-    amount: string;
-    currency: string;
-}
 /** A credit allocation applied to an invoice line item. */
 export interface InvoiceLineCreditsApplied {
     /** The monetary amount credited. */
@@ -751,6 +762,11 @@ export interface LlmCostModelPricing {
     /** Reasoning output price per token (USD). */
     reasoningPerToken?: string;
 }
+/** Monetary amount in a specific fiat currency. */
+export interface FiatCurrencyAmount {
+    amount: string;
+    currency: string;
+}
 /**
  * A query filter for a numeric attribute. Operators are mutually exclusive, only
  * one operator is allowed at a time.
@@ -863,6 +879,15 @@ export interface SubscriptionReference {
         };
     };
 }
+/** Cost basis pinned to a specific cost basis resource of the custom currency. */
+export interface ChargeCostBasisPinned {
+    /** Discriminator selecting the cost basis mode. */
+    type: 'pinned';
+    /** The fiat currency the charge amount is converted into for invoicing. */
+    fiatCurrency: string;
+    /** ID of the custom currency's cost basis resource to pin. */
+    costBasisId: string;
+}
 /** App reference. */
 export interface AppReference {
     /** The ID of the app. */
@@ -1041,6 +1066,24 @@ export interface ClosedPeriod {
      */
     to: Date;
 }
+/**
+ * Fiat conversion rate a custom-currency charge is invoiced at. Present once the
+ * cost basis is resolved; dynamic cost bases are exposed only after the service
+ * period has started.
+ */
+export interface ChargeResolvedCostBasis {
+    /** The fiat currency the charge amount is converted into for invoicing. */
+    fiatCurrency: string;
+    /** Fiat amount per one unit of the custom currency. */
+    rate: string;
+    /**
+     * ID of the custom currency's cost basis resource the rate was taken from. Absent
+     * for manual cost bases.
+     */
+    costBasisId?: string;
+    /** When the rate was resolved. */
+    resolvedAt: Date;
+}
 /** A subscription add-on event. */
 export interface SubscriptionAddonTimelineSegment {
     /** An ISO-8601 timestamp representation of the cadence start of the resource. */
@@ -2300,6 +2343,13 @@ export interface CreditTransaction {
         after: string;
     };
 }
+/** Monetary amount in a fiat or custom currency. */
+export interface CurrencyAmount {
+    /** The amount as an arbitrary-precision decimal string. */
+    amount: string;
+    /** The fiat or custom currency code of the amount. */
+    currency: BillingCurrencyCode;
+}
 /**
  * A price tier used in graduated and volume pricing.
  *
@@ -3074,46 +3124,6 @@ export interface WorkflowCollectionAlignmentAnchored {
     /** The recurring period for the alignment. */
     recurringPeriod: RecurringPeriod;
 }
-/**
- * Flat fee intent fields from the system lifecycle controller shadowed by a manual
- * override.
- */
-export interface ChargeFlatFeeSystemIntent {
-    /**
-     * Display name of the resource.
-     *
-     * Between 1 and 256 characters.
-     */
-    name: string;
-    /**
-     * Optional description of the resource.
-     *
-     * Maximum 1024 characters.
-     */
-    description?: string;
-    labels?: Labels;
-    /** The timestamp when the charge is intended to be invoiced. */
-    invoiceAt: Date;
-    /** The effective service period covered by the charge. */
-    servicePeriod: ClosedPeriod;
-    /** The full, unprorated service period of the charge. */
-    fullServicePeriod: ClosedPeriod;
-    /** The billing period the charge belongs to. */
-    billingPeriod: ClosedPeriod;
-    /** Payment term of the flat fee charge. */
-    paymentTerm: PricePaymentTerm;
-    /** The discounts applied to the charge. */
-    discounts?: ChargeFlatFeeDiscounts;
-    /** The proration configuration of the charge. */
-    prorationConfiguration: RateCardProrationConfiguration;
-    /** The amount before proration of the system lifecycle controller flat fee intent. */
-    amountBeforeProration: CurrencyAmount;
-    /**
-     * The timestamp when the system lifecycle controller intent was deleted. The
-     * effective charge can remain visible while a manual override is active.
-     */
-    deletedAt?: Date;
-}
 /** Detailed status information for a standard invoice. */
 export interface InvoiceStatusDetails {
     /** Whether the invoice is immutable (i.e. cannot be modified or deleted). */
@@ -3357,6 +3367,46 @@ export interface CreditTransactionPaginatedResponse {
     data: CreditTransaction[];
     meta: CursorMeta;
 }
+/**
+ * Flat fee intent fields from the system lifecycle controller shadowed by a manual
+ * override.
+ */
+export interface ChargeFlatFeeSystemIntent {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** The timestamp when the charge is intended to be invoiced. */
+    invoiceAt: Date;
+    /** The effective service period covered by the charge. */
+    servicePeriod: ClosedPeriod;
+    /** The full, unprorated service period of the charge. */
+    fullServicePeriod: ClosedPeriod;
+    /** The billing period the charge belongs to. */
+    billingPeriod: ClosedPeriod;
+    /** Payment term of the flat fee charge. */
+    paymentTerm: PricePaymentTerm;
+    /** The discounts applied to the charge. */
+    discounts?: ChargeFlatFeeDiscounts;
+    /** The proration configuration of the charge. */
+    prorationConfiguration: RateCardProrationConfiguration;
+    /** The amount before proration of the system lifecycle controller flat fee intent. */
+    amountBeforeProration: CurrencyAmount;
+    /**
+     * The timestamp when the system lifecycle controller intent was deleted. The
+     * effective charge can remain visible while a manual override is active.
+     */
+    deletedAt?: Date;
+}
 /**
  * Graduated tiered price.
  *
@@ -3552,6 +3602,30 @@ export interface CreditGrant {
     /** Current lifecycle status of the grant. */
     status: 'pending' | 'active' | 'expired' | 'voided';
 }
+/** Tax settings for a billing workflow. */
+export interface WorkflowTaxSettings {
+    /**
+     * Enable automatic tax calculation when tax is supported by the app. For example,
+     * with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.
+     */
+    enabled: boolean;
+    /**
+     * Enforce tax calculation when tax is supported by the app. When enabled, the
+     * billing system will not allow to create an invoice without tax calculation.
+     * Enforcement is different per apps, for example, Stripe app requires customer to
+     * have a tax location when starting a paid subscription.
+     */
+    enforced: boolean;
+    /**
+     * Default tax configuration to apply to the invoices for line items.
+     *
+     * Setting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax
+     * config is deprecated and can no longer be added or changed: the organization
+     * default tax code is used instead. Existing tax-code values may still be removed,
+     * and `behavior` remains fully supported.
+     */
+    defaultTaxConfig?: TaxConfig;
+}
 /** Flat fee charge create request. */
 export interface CreateChargeFlatFeeRequest {
     /**
@@ -3570,7 +3644,14 @@ export interface CreateChargeFlatFeeRequest {
     /** The type of the charge. */
     type: 'flat_fee';
     /** The currency of the charge. */
-    currency: string;
+    currency: BillingCurrencyCode;
+    /**
+     * Defines how a custom-currency charge is converted into its fiat invoice
+     * currency; the resolved rate is exposed through `resolved_cost_basis`. Required
+     * when `currency` is custom and the charge settles as `credit_then_invoice`; must
+     * be omitted otherwise.
+     */
+    costBasis?: ChargeCostBasis;
     /** The timestamp when the charge is intended to be invoiced. */
     invoiceAt: Date;
     /** The effective service period covered by the charge. */
@@ -3596,30 +3677,6 @@ export interface CreateChargeFlatFeeRequest {
     /** The billing period the charge belongs to. */
     billingPeriod?: ClosedPeriod;
 }
-/** Tax settings for a billing workflow. */
-export interface WorkflowTaxSettings {
-    /**
-     * Enable automatic tax calculation when tax is supported by the app. For example,
-     * with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.
-     */
-    enabled: boolean;
-    /**
-     * Enforce tax calculation when tax is supported by the app. When enabled, the
-     * billing system will not allow to create an invoice without tax calculation.
-     * Enforcement is different per apps, for example, Stripe app requires customer to
-     * have a tax location when starting a paid subscription.
-     */
-    enforced: boolean;
-    /**
-     * Default tax configuration to apply to the invoices for line items.
-     *
-     * Setting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax
-     * config is deprecated and can no longer be added or changed: the organization
-     * default tax code is used instead. Existing tax-code values may still be removed,
-     * and `behavior` remains fully supported.
-     */
-    defaultTaxConfig?: TaxConfig;
-}
 /** Page paginated response. */
 export interface PlanAddonPagePaginatedResponse {
     data: PlanAddon[];
@@ -4586,7 +4643,14 @@ export interface CreateChargeUsageBasedRequest {
     /** The type of the charge. */
     type: 'usage_based';
     /** The currency of the charge. */
-    currency: string;
+    currency: BillingCurrencyCode;
+    /**
+     * Defines how a custom-currency charge is converted into its fiat invoice
+     * currency; the resolved rate is exposed through `resolved_cost_basis`. Required
+     * when `currency` is custom and the charge settles as `credit_then_invoice`; must
+     * be omitted otherwise.
+     */
+    costBasis?: ChargeCostBasis;
     /** The timestamp when the charge is intended to be invoiced. */
     invoiceAt: Date;
     /** The effective service period covered by the charge. */
@@ -5583,7 +5647,13 @@ export interface ChargeFlatFee {
      */
     subscription?: SubscriptionOrReference;
     /** The currency of the charge. */
-    currency: string;
+    currency: BillingCurrencyCode;
+    /**
+     * The resolved fiat conversion rate of a custom-currency charge. Resolution
+     * depends on costbasis type: dynamic is resolved when charge becomes active, all
+     * other types resolved on creation.
+     */
+    resolvedCostBasis?: ChargeResolvedCostBasis;
     /** The lifecycle status of the charge. */
     status: 'created' | 'active' | 'final' | 'deleted';
     /** The timestamp when the charge is intended to be invoiced. */
@@ -5671,7 +5741,13 @@ export interface ChargeUsageBased {
      */
     subscription?: SubscriptionOrReference;
     /** The currency of the charge. */
-    currency: string;
+    currency: BillingCurrencyCode;
+    /**
+     * The resolved fiat conversion rate of a custom-currency charge. Resolution
+     * depends on costbasis type: dynamic is resolved when charge becomes active, all
+     * other types resolved on creation.
+     */
+    resolvedCostBasis?: ChargeResolvedCostBasis;
     /** The lifecycle status of the charge. */
     status: 'created' | 'active' | 'final' | 'deleted';
     /** The timestamp when the charge is intended to be invoiced. */
@@ -5815,6 +5891,11 @@ export type SubscriptionEditTiming = 'immediate' | 'next_billing_cycle' | Date;
 export type InstallAppRequest = InstallAppStripeWithApiKey | InstallAppSandbox | InstallAppExternalInvoicing;
 /** Payment settings for a billing workflow. */
 export type UpdateBillingWorkflowPaymentSettings = UpdateBillingWorkflowPaymentChargeAutomaticallySettings | UpdateBillingWorkflowPaymentSendInvoiceSettings;
+/**
+ * Cost basis selection for a custom-currency charge. The variant chosen fixes when
+ * and how the conversion rate is determined.
+ */
+export type ChargeCostBasis = ChargeCostBasisDynamic | ChargeCostBasisPinned | ChargeCostBasisManual;
 /** A parameter that failed validation. */
 export type InvalidParameter = InvalidParameterStandard | InvalidParameterMinimumLength | InvalidParameterMaximumLength | InvalidParameterChoiceItem | InvalidParameterDependentItem;
 /**
@@ -6993,7 +7074,14 @@ export interface CreateChargeUsageBasedRequestInput {
     /** The type of the charge. */
     type: 'usage_based';
     /** The currency of the charge. */
-    currency: string;
+    currency: BillingCurrencyCode;
+    /**
+     * Defines how a custom-currency charge is converted into its fiat invoice
+     * currency; the resolved rate is exposed through `resolved_cost_basis`. Required
+     * when `currency` is custom and the charge settles as `credit_then_invoice`; must
+     * be omitted otherwise.
+     */
+    costBasis?: ChargeCostBasis;
     /** The timestamp when the charge is intended to be invoiced. */
     invoiceAt: Date;
     /** The effective service period covered by the charge. */
@@ -7918,7 +8006,13 @@ export interface ChargeFlatFeeInput {
      */
     subscription?: SubscriptionOrReferenceInput;
     /** The currency of the charge. */
-    currency: string;
+    currency: BillingCurrencyCode;
+    /**
+     * The resolved fiat conversion rate of a custom-currency charge. Resolution
+     * depends on costbasis type: dynamic is resolved when charge becomes active, all
+     * other types resolved on creation.
+     */
+    resolvedCostBasis?: ChargeResolvedCostBasis;
     /** The lifecycle status of the charge. */
     status: 'created' | 'active' | 'final' | 'deleted';
     /** The timestamp when the charge is intended to be invoiced. */
@@ -8006,7 +8100,13 @@ export interface ChargeUsageBasedInput {
      */
     subscription?: SubscriptionOrReferenceInput;
     /** The currency of the charge. */
-    currency: string;
+    currency: BillingCurrencyCode;
+    /**
+     * The resolved fiat conversion rate of a custom-currency charge. Resolution
+     * depends on costbasis type: dynamic is resolved when charge becomes active, all
+     * other types resolved on creation.
+     */
+    resolvedCostBasis?: ChargeResolvedCostBasis;
     /** The lifecycle status of the charge. */
     status: 'created' | 'active' | 'final' | 'deleted';
     /** The timestamp when the charge is intended to be invoiced. */

package/package.json

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