@openmeter/client 1.0.0-beta-d6d4cd22dad8 → 1.0.0-beta-84dd0f294013

package/dist/models/schemas.js

@@ -471,6 +471,9 @@ export const priceFree = z
     type: z.literal('free').describe('The type of the price.'),
 })
     .describe('Free price.');
+export const subscriptionCostBasisMode = z
+    .enum(['dynamic', 'pinned'])
+    .describe('Controls how custom-currency cost bases are selected for the subscription.');
 export const subscriptionStatus = z
     .enum(['active', 'inactive', 'canceled', 'scheduled'])
     .describe('Subscription status.');
@@ -1321,6 +1324,13 @@ export const subscriptionReference = z
         .describe('The phase of the subscription.'),
 })
     .describe('Subscription reference represents a reference to the specific subscription item this entity represents.');
+export const subscriptionCostBasisPin = z
+    .object({
+    customCurrencyId: ulid,
+    invoiceCurrency: currencyCode,
+    costBasisId: ulid,
+})
+    .describe('A cost basis pinned to a custom-currency pair for the subscription.');
 export const addonReference = z
     .object({
     id: ulid,
@@ -2044,6 +2054,11 @@ export const voidCreditGrantRequest = z
         .default('none'),
 })
     .describe('Request body for voiding a credit grant.');
+export const rateCardProrationConfiguration = z
+    .object({
+    mode: rateCardProrationMode,
+})
+    .describe('The proration configuration of the rate card.');
 export const subscriptionCreate = z
     .object({
     labels: labels.optional(),
@@ -2066,27 +2081,9 @@ export const subscriptionCreate = z
     })
         .describe('The plan reference of the subscription.'),
     billingAnchor: dateTime.optional(),
+    costBasisMode: subscriptionCostBasisMode.optional().default('dynamic'),
 })
     .describe('Subscription create request.');
-export const rateCardProrationConfiguration = z
-    .object({
-    mode: rateCardProrationMode,
-})
-    .describe('The proration configuration of the rate card.');
-export const subscription = z
-    .object({
-    id: ulid,
-    labels: labels.optional(),
-    createdAt: dateTime,
-    updatedAt: dateTime,
-    deletedAt: dateTime.optional(),
-    customerId: ulid,
-    planId: ulid.optional(),
-    billingAnchor: dateTime,
-    status: subscriptionStatus,
-    settlementMode: settlementMode.optional(),
-})
-    .describe('Subscription.');
 export const subscriptionEditTiming = z
     .union([subscriptionEditTimingEnum, dateTime])
     .describe('Subscription edit timing defined when the changes should take effect. If the provided configuration is not supported by the subscription, an error will be returned.');
@@ -2566,6 +2563,25 @@ export const updateOrganizationDefaultTaxCodesRequest = z
     creditGrantTaxCode: taxCodeReference.optional(),
 })
     .describe('OrganizationDefaultTaxCodes update request.');
+export const subscription = z
+    .object({
+    id: ulid,
+    labels: labels.optional(),
+    createdAt: dateTime,
+    updatedAt: dateTime,
+    deletedAt: dateTime.optional(),
+    customerId: ulid,
+    planId: ulid.optional(),
+    invoiceCurrency: currencyCode,
+    costBasisMode: subscriptionCostBasisMode.default('dynamic'),
+    costBasisPins: z
+        .array(subscriptionCostBasisPin)
+        .describe('Cost bases pinned to custom-currency pairs for this subscription.'),
+    billingAnchor: dateTime,
+    status: subscriptionStatus,
+    settlementMode: settlementMode.optional(),
+})
+    .describe('Subscription.');
 export const planAddon = z
     .object({
     id: ulid,
@@ -2945,18 +2961,6 @@ export const chargeFlatFeeSystemIntent = z
     deletedAt: dateTime.optional(),
 })
     .describe('Flat fee intent fields from the system lifecycle controller shadowed by a manual override.');
-export const subscriptionPagePaginatedResponse = z
-    .object({
-    data: z.array(subscription),
-    meta: paginatedMeta,
-})
-    .describe('Page paginated response.');
-export const subscriptionChangeResponse = z
-    .object({
-    current: subscription,
-    next: subscription,
-})
-    .describe('Response for changing a subscription.');
 export const subscriptionCancel = z
     .object({
     timing: subscriptionEditTiming.optional().default('immediate'),
@@ -2984,6 +2988,7 @@ export const subscriptionChange = z
     })
         .describe('The plan reference of the subscription.'),
     billingAnchor: dateTime.optional(),
+    costBasisMode: subscriptionCostBasisMode.optional().default('dynamic'),
     timing: subscriptionEditTiming,
 })
     .describe('Request for changing a subscription.');
@@ -3311,6 +3316,18 @@ export const workflowTaxSettings = z
     defaultTaxConfig: taxConfig.optional(),
 })
     .describe('Tax settings for a billing workflow.');
+export const subscriptionPagePaginatedResponse = z
+    .object({
+    data: z.array(subscription),
+    meta: paginatedMeta,
+})
+    .describe('Page paginated response.');
+export const subscriptionChangeResponse = z
+    .object({
+    current: subscription,
+    next: subscription,
+})
+    .describe('Response for changing a subscription.');
 export const planAddonPagePaginatedResponse = z
     .object({
     data: z.array(planAddon),
@@ -5606,6 +5623,9 @@ export const priceFreeWire = z
     type: z.literal('free').describe('The type of the price.'),
 })
     .describe('Free price.');
+export const subscriptionCostBasisModeWire = z
+    .enum(['dynamic', 'pinned'])
+    .describe('Controls how custom-currency cost bases are selected for the subscription.');
 export const subscriptionStatusWire = z
     .enum(['active', 'inactive', 'canceled', 'scheduled'])
     .describe('Subscription status.');
@@ -6450,6 +6470,13 @@ export const subscriptionReferenceWire = z
         .describe('The phase of the subscription.'),
 })
     .describe('Subscription reference represents a reference to the specific subscription item this entity represents.');
+export const subscriptionCostBasisPinWire = z
+    .strictObject({
+    custom_currency_id: ulidWire,
+    invoice_currency: currencyCodeWire,
+    cost_basis_id: ulidWire,
+})
+    .describe('A cost basis pinned to a custom-currency pair for the subscription.');
 export const addonReferenceWire = z
     .strictObject({
     id: ulidWire,
@@ -7156,6 +7183,11 @@ export const voidCreditGrantRequestWire = z
     payment_adjustment: creditGrantVoidPaymentAdjustmentWire.optional(),
 })
     .describe('Request body for voiding a credit grant.');
+export const rateCardProrationConfigurationWire = z
+    .strictObject({
+    mode: rateCardProrationModeWire,
+})
+    .describe('The proration configuration of the rate card.');
 export const subscriptionCreateWire = z
     .strictObject({
     labels: labelsWire.optional(),
@@ -7178,27 +7210,9 @@ export const subscriptionCreateWire = z
     })
         .describe('The plan reference of the subscription.'),
     billing_anchor: dateTimeWire.optional(),
+    cost_basis_mode: subscriptionCostBasisModeWire.optional(),
 })
     .describe('Subscription create request.');
-export const rateCardProrationConfigurationWire = z
-    .strictObject({
-    mode: rateCardProrationModeWire,
-})
-    .describe('The proration configuration of the rate card.');
-export const subscriptionWire = z
-    .strictObject({
-    id: ulidWire,
-    labels: labelsWire.optional(),
-    created_at: dateTimeWire,
-    updated_at: dateTimeWire,
-    deleted_at: dateTimeWire.optional(),
-    customer_id: ulidWire,
-    plan_id: ulidWire.optional(),
-    billing_anchor: dateTimeWire,
-    status: subscriptionStatusWire,
-    settlement_mode: settlementModeWire.optional(),
-})
-    .describe('Subscription.');
 export const subscriptionEditTimingWire = z
     .union([subscriptionEditTimingEnumWire, dateTimeWire])
     .describe('Subscription edit timing defined when the changes should take effect. If the provided configuration is not supported by the subscription, an error will be returned.');
@@ -7671,6 +7685,25 @@ export const updateOrganizationDefaultTaxCodesRequestWire = z
     credit_grant_tax_code: taxCodeReferenceWire.optional(),
 })
     .describe('OrganizationDefaultTaxCodes update request.');
+export const subscriptionWire = z
+    .strictObject({
+    id: ulidWire,
+    labels: labelsWire.optional(),
+    created_at: dateTimeWire,
+    updated_at: dateTimeWire,
+    deleted_at: dateTimeWire.optional(),
+    customer_id: ulidWire,
+    plan_id: ulidWire.optional(),
+    invoice_currency: currencyCodeWire,
+    cost_basis_mode: subscriptionCostBasisModeWire,
+    cost_basis_pins: z
+        .array(subscriptionCostBasisPinWire)
+        .describe('Cost bases pinned to custom-currency pairs for this subscription.'),
+    billing_anchor: dateTimeWire,
+    status: subscriptionStatusWire,
+    settlement_mode: settlementModeWire.optional(),
+})
+    .describe('Subscription.');
 export const planAddonWire = z
     .strictObject({
     id: ulidWire,
@@ -8050,18 +8083,6 @@ export const chargeFlatFeeSystemIntentWire = z
     deleted_at: dateTimeWire.optional(),
 })
     .describe('Flat fee intent fields from the system lifecycle controller shadowed by a manual override.');
-export const subscriptionPagePaginatedResponseWire = z
-    .strictObject({
-    data: z.array(subscriptionWire),
-    meta: paginatedMetaWire,
-})
-    .describe('Page paginated response.');
-export const subscriptionChangeResponseWire = z
-    .strictObject({
-    current: subscriptionWire,
-    next: subscriptionWire,
-})
-    .describe('Response for changing a subscription.');
 export const subscriptionCancelWire = z
     .strictObject({
     timing: subscriptionEditTimingWire.optional(),
@@ -8089,6 +8110,7 @@ export const subscriptionChangeWire = z
     })
         .describe('The plan reference of the subscription.'),
     billing_anchor: dateTimeWire.optional(),
+    cost_basis_mode: subscriptionCostBasisModeWire.optional(),
     timing: subscriptionEditTimingWire,
 })
     .describe('Request for changing a subscription.');
@@ -8419,6 +8441,18 @@ export const workflowTaxSettingsWire = z
     default_tax_config: taxConfigWire.optional(),
 })
     .describe('Tax settings for a billing workflow.');
+export const subscriptionPagePaginatedResponseWire = z
+    .strictObject({
+    data: z.array(subscriptionWire),
+    meta: paginatedMetaWire,
+})
+    .describe('Page paginated response.');
+export const subscriptionChangeResponseWire = z
+    .strictObject({
+    current: subscriptionWire,
+    next: subscriptionWire,
+})
+    .describe('Response for changing a subscription.');
 export const planAddonPagePaginatedResponseWire = z
     .strictObject({
     data: z.array(planAddonWire),

package/dist/models/types.d.ts

@@ -822,6 +822,15 @@ export interface SubscriptionReference {
         };
     };
 }
+/** A cost basis pinned to a custom-currency pair for the subscription. */
+export interface SubscriptionCostBasisPin {
+    /** The managed custom currency ID. */
+    customCurrencyId: string;
+    /** The fiat currency in which the subscription is invoiced. */
+    invoiceCurrency: string;
+    /** The pinned cost basis resource ID. */
+    costBasisId: string;
+}
 /** Addon reference. */
 export interface AddonReference {
     id: string;
@@ -1745,6 +1754,11 @@ export interface VoidCreditGrantRequest {
      */
     paymentAdjustment: 'none';
 }
+/** The proration configuration of the rate card. */
+export interface RateCardProrationConfiguration {
+    /** The proration mode of the rate card. */
+    mode: 'no_proration' | 'prorate_prices';
+}
 /** Subscription create request. */
 export interface SubscriptionCreate {
     labels?: Labels;
@@ -1782,48 +1796,8 @@ export interface SubscriptionCreate {
      * creation time as the billing anchor.
      */
     billingAnchor?: Date;
-}
-/** The proration configuration of the rate card. */
-export interface RateCardProrationConfiguration {
-    /** The proration mode of the rate card. */
-    mode: 'no_proration' | 'prorate_prices';
-}
-/** Subscription. */
-export interface Subscription {
-    id: string;
-    labels?: Labels;
-    /** An ISO-8601 timestamp representation of entity creation date. */
-    createdAt: Date;
-    /** An ISO-8601 timestamp representation of entity last update date. */
-    updatedAt: Date;
-    /** An ISO-8601 timestamp representation of entity deletion date. */
-    deletedAt?: Date;
-    /** The customer ID of the subscription. */
-    customerId: string;
-    /** The plan ID of the subscription. Set if subscription is created from a plan. */
-    planId?: string;
-    /**
-     * A billing anchor is the fixed point in time that determines the subscription's
-     * recurring billing cycle. It affects when charges occur and how prorations are
-     * calculated. Common anchors:
-     *
-     * - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
-     * - Subscription anniversary (day customer signed up)
-     * - Custom date (customer-specified day)
-     */
-    billingAnchor: Date;
-    /** The status of the subscription. */
-    status: 'active' | 'inactive' | 'canceled' | 'scheduled';
-    /**
-     * Settlement mode for billing.
-     *
-     * Values:
-     *
-     * - `credit_then_invoice`: Credits are applied first, then any remainder is
-     * invoiced.
-     * - `credit_only`: Usage is settled exclusively against credits.
-     */
-    settlementMode?: 'credit_then_invoice' | 'credit_only';
+    /** Controls how custom-currency cost bases are selected for the subscription. */
+    costBasisMode: 'dynamic' | 'pinned';
 }
 /**
  * Unit conversion configuration.
@@ -2502,6 +2476,52 @@ export interface UpdateOrganizationDefaultTaxCodesRequest {
     /** Default tax code for credit grants. */
     creditGrantTaxCode?: TaxCodeReference;
 }
+/** Subscription. */
+export interface Subscription {
+    id: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    createdAt: Date;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updatedAt: Date;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deletedAt?: Date;
+    /** The customer ID of the subscription. */
+    customerId: string;
+    /** The plan ID of the subscription. Set if subscription is created from a plan. */
+    planId?: string;
+    /** The fiat currency in which the subscription is invoiced. */
+    invoiceCurrency: string;
+    /**
+     * Controls whether custom-currency cost bases are resolved dynamically or pinned
+     * when their currency pair is introduced to the subscription.
+     */
+    costBasisMode: 'dynamic' | 'pinned';
+    /** Cost bases pinned to custom-currency pairs for this subscription. */
+    costBasisPins: SubscriptionCostBasisPin[];
+    /**
+     * A billing anchor is the fixed point in time that determines the subscription's
+     * recurring billing cycle. It affects when charges occur and how prorations are
+     * calculated. Common anchors:
+     *
+     * - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
+     * - Subscription anniversary (day customer signed up)
+     * - Custom date (customer-specified day)
+     */
+    billingAnchor: Date;
+    /** The status of the subscription. */
+    status: 'active' | 'inactive' | 'canceled' | 'scheduled';
+    /**
+     * Settlement mode for billing.
+     *
+     * Values:
+     *
+     * - `credit_then_invoice`: Credits are applied first, then any remainder is
+     * invoiced.
+     * - `credit_only`: Usage is settled exclusively against credits.
+     */
+    settlementMode?: 'credit_then_invoice' | 'credit_only';
+}
 /**
  * PlanAddon represents an association between a plan and an add-on, controlling
  * which add-ons are available for purchase within a plan.
@@ -2960,18 +2980,6 @@ export interface ChargeFlatFeeSystemIntent {
      */
     deletedAt?: Date;
 }
-/** Page paginated response. */
-export interface SubscriptionPagePaginatedResponse {
-    data: Subscription[];
-    meta: PaginatedMeta;
-}
-/** Response for changing a subscription. */
-export interface SubscriptionChangeResponse {
-    /** The current subscription before the change. */
-    current: Subscription;
-    /** The new state of the subscription after the change. */
-    next: Subscription;
-}
 /** Request for canceling a subscription. */
 export interface SubscriptionCancel {
     /** If not provided the subscription is canceled immediately. */
@@ -3014,6 +3022,8 @@ export interface SubscriptionChange {
      * creation time as the billing anchor.
      */
     billingAnchor?: Date;
+    /** Controls how custom-currency cost bases are selected for the subscription. */
+    costBasisMode: 'dynamic' | 'pinned';
     /**
      * Timing configuration for the change, when the change should take effect. For
      * changing a subscription, the accepted values depend on the subscription
@@ -3477,6 +3487,18 @@ export interface WorkflowTaxSettings {
     defaultTaxConfig?: TaxConfig;
 }
 /** Page paginated response. */
+export interface SubscriptionPagePaginatedResponse {
+    data: Subscription[];
+    meta: PaginatedMeta;
+}
+/** Response for changing a subscription. */
+export interface SubscriptionChangeResponse {
+    /** The current subscription before the change. */
+    current: Subscription;
+    /** The new state of the subscription after the change. */
+    next: Subscription;
+}
+/** Page paginated response. */
 export interface PlanAddonPagePaginatedResponse {
     data: PlanAddon[];
     meta: PaginatedMeta;
@@ -5513,6 +5535,46 @@ export interface VoidCreditGrantRequestInput {
      */
     paymentAdjustment?: 'none';
 }
+/** Subscription create request. */
+export interface SubscriptionCreateInput {
+    labels?: Labels;
+    /**
+     * Settlement mode for billing.
+     *
+     * Values:
+     *
+     * - `credit_then_invoice`: Credits are applied first, then any remainder is
+     * invoiced.
+     * - `credit_only`: Usage is settled exclusively against credits.
+     */
+    settlementMode?: 'credit_then_invoice' | 'credit_only';
+    /** The customer to create the subscription for. */
+    customer: {
+        id?: string;
+        key?: string;
+    };
+    /** The plan reference of the subscription. */
+    plan: {
+        id?: string;
+        key?: string;
+        version?: number;
+    };
+    /**
+     * A billing anchor is the fixed point in time that determines the subscription's
+     * recurring billing cycle. It affects when charges occur and how prorations are
+     * calculated. Common anchors:
+     *
+     * - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
+     * - Subscription anniversary (day customer signed up)
+     * - Custom date (customer-specified day)
+     *
+     * If not provided, the subscription will be created with the subscription's
+     * creation time as the billing anchor.
+     */
+    billingAnchor?: Date;
+    /** Controls how custom-currency cost bases are selected for the subscription. */
+    costBasisMode?: 'dynamic' | 'pinned';
+}
 /**
  * Unit conversion configuration.
  *
@@ -5594,6 +5656,52 @@ export interface GovernanceQueryRequestInput {
     customer: GovernanceQueryRequestCustomers;
     feature?: GovernanceQueryRequestFeatures;
 }
+/** Subscription. */
+export interface SubscriptionInput {
+    id: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    createdAt: Date;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updatedAt: Date;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deletedAt?: Date;
+    /** The customer ID of the subscription. */
+    customerId: string;
+    /** The plan ID of the subscription. Set if subscription is created from a plan. */
+    planId?: string;
+    /** The fiat currency in which the subscription is invoiced. */
+    invoiceCurrency: string;
+    /**
+     * Controls whether custom-currency cost bases are resolved dynamically or pinned
+     * when their currency pair is introduced to the subscription.
+     */
+    costBasisMode?: 'dynamic' | 'pinned';
+    /** Cost bases pinned to custom-currency pairs for this subscription. */
+    costBasisPins: SubscriptionCostBasisPin[];
+    /**
+     * A billing anchor is the fixed point in time that determines the subscription's
+     * recurring billing cycle. It affects when charges occur and how prorations are
+     * calculated. Common anchors:
+     *
+     * - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
+     * - Subscription anniversary (day customer signed up)
+     * - Custom date (customer-specified day)
+     */
+    billingAnchor: Date;
+    /** The status of the subscription. */
+    status: 'active' | 'inactive' | 'canceled' | 'scheduled';
+    /**
+     * Settlement mode for billing.
+     *
+     * Values:
+     *
+     * - `credit_then_invoice`: Credits are applied first, then any remainder is
+     * invoiced.
+     * - `credit_only`: Usage is settled exclusively against credits.
+     */
+    settlementMode?: 'credit_then_invoice' | 'credit_only';
+}
 /** An ingested metering event with ingestion metadata. */
 export interface IngestedEventInput {
     /** The original event ingested. */
@@ -5612,6 +5720,52 @@ export interface SubscriptionCancelInput {
     /** If not provided the subscription is canceled immediately. */
     timing?: SubscriptionEditTiming;
 }
+/** Request for changing a subscription. */
+export interface SubscriptionChangeInput {
+    labels?: Labels;
+    /**
+     * Settlement mode for billing.
+     *
+     * Values:
+     *
+     * - `credit_then_invoice`: Credits are applied first, then any remainder is
+     * invoiced.
+     * - `credit_only`: Usage is settled exclusively against credits.
+     */
+    settlementMode?: 'credit_then_invoice' | 'credit_only';
+    /** The customer to create the subscription for. */
+    customer: {
+        id?: string;
+        key?: string;
+    };
+    /** The plan reference of the subscription. */
+    plan: {
+        id?: string;
+        key?: string;
+        version?: number;
+    };
+    /**
+     * A billing anchor is the fixed point in time that determines the subscription's
+     * recurring billing cycle. It affects when charges occur and how prorations are
+     * calculated. Common anchors:
+     *
+     * - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
+     * - Subscription anniversary (day customer signed up)
+     * - Custom date (customer-specified day)
+     *
+     * If not provided, the subscription will be created with the subscription's
+     * creation time as the billing anchor.
+     */
+    billingAnchor?: Date;
+    /** Controls how custom-currency cost bases are selected for the subscription. */
+    costBasisMode?: 'dynamic' | 'pinned';
+    /**
+     * Timing configuration for the change, when the change should take effect. For
+     * changing a subscription, the accepted values depend on the subscription
+     * configuration.
+     */
+    timing: SubscriptionEditTiming;
+}
 /**
  * Invoice-level snapshot of the workflow configuration.
  *
@@ -5792,6 +5946,18 @@ export interface WorkflowTaxSettingsInput {
      */
     defaultTaxConfig?: TaxConfig;
 }
+/** Page paginated response. */
+export interface SubscriptionPagePaginatedResponseInput {
+    data: SubscriptionInput[];
+    meta: PaginatedMeta;
+}
+/** Response for changing a subscription. */
+export interface SubscriptionChangeResponseInput {
+    /** The current subscription before the change. */
+    current: SubscriptionInput;
+    /** The new state of the subscription after the change. */
+    next: SubscriptionInput;
+}
 /** Cursor paginated response. */
 export interface IngestedEventPaginatedResponseInput {
     data: IngestedEventInput[];

package/package.json

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