@openmeter/client 1.0.0-beta-75dd3b9ccc98 → 1.0.0-beta-471c6cd3d433

package/dist/models/schemas.js

@@ -2229,31 +2229,6 @@ export const rateCardProrationConfiguration = z
     mode: rateCardProrationMode,
 })
     .describe('The proration configuration of the rate card.');
-export const subscriptionCreate = z
-    .object({
-    labels: labels.optional(),
-    settlementMode: settlementMode.optional(),
-    customer: z
-        .object({
-        id: ulid.optional(),
-        key: externalResourceKey.optional(),
-    })
-        .describe('The customer to create the subscription for.'),
-    plan: z
-        .object({
-        id: ulid.optional(),
-        key: resourceKey.optional(),
-        version: z
-            .number()
-            .int()
-            .optional()
-            .describe('The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.'),
-    })
-        .describe('The plan reference of the subscription.'),
-    billingAnchor: dateTime.optional(),
-    costBasisMode: subscriptionCostBasisMode.optional().default('dynamic'),
-})
-    .describe('Subscription create request.');
 export const unitConfig = z
     .object({
     operation: unitConfigOperation,
@@ -3214,32 +3189,6 @@ export const subscriptionCancel = z
     timing: subscriptionEditTiming.optional().default('immediate'),
 })
     .describe('Request for canceling a subscription.');
-export const subscriptionChange = z
-    .object({
-    labels: labels.optional(),
-    settlementMode: settlementMode.optional(),
-    customer: z
-        .object({
-        id: ulid.optional(),
-        key: externalResourceKey.optional(),
-    })
-        .describe('The customer to create the subscription for.'),
-    plan: z
-        .object({
-        id: ulid.optional(),
-        key: resourceKey.optional(),
-        version: z
-            .number()
-            .int()
-            .optional()
-            .describe('The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.'),
-    })
-        .describe('The plan reference of the subscription.'),
-    billingAnchor: dateTime.optional(),
-    costBasisMode: subscriptionCostBasisMode.optional().default('dynamic'),
-    timing: subscriptionEditTiming,
-})
-    .describe('Request for changing a subscription.');
 export const createSubscriptionAddonRequest = z
     .object({
     labels: labels.optional(),
@@ -4271,23 +4220,6 @@ export const subscriptionItem = z
     rateCard: rateCard,
 })
     .describe('A subscription item pins a rate card to a cadence within a subscription phase.');
-export const subscriptionEditAddItem = z
-    .object({
-    type: z
-        .literal('add_item')
-        .describe('Discriminator for the add-item operation.'),
-    phaseKey: z.string().describe('The key of the phase to add the item to.'),
-    rateCard: rateCard,
-})
-    .describe('Add a new rate card to a phase. Adding an item to the current phase closes the active version of the same item key and appends a new version.');
-export const subscriptionAddonRateCard = z
-    .object({
-    rateCard: rateCard,
-    affectedSubscriptionItemIds: z
-        .array(ulid)
-        .describe('The IDs of the subscription items that this rate card belongs to.'),
-})
-    .describe('A rate card for a subscription add-on.');
 export const planPhase = z
     .object({
     name: z
@@ -4306,6 +4238,23 @@ export const planPhase = z
     rateCards: z.array(rateCard).describe('The rate cards of the plan.'),
 })
     .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.");
+export const subscriptionEditAddItem = z
+    .object({
+    type: z
+        .literal('add_item')
+        .describe('Discriminator for the add-item operation.'),
+    phaseKey: z.string().describe('The key of the phase to add the item to.'),
+    rateCard: rateCard,
+})
+    .describe('Add a new rate card to a phase. Adding an item to the current phase closes the active version of the same item key and appends a new version.');
+export const subscriptionAddonRateCard = z
+    .object({
+    rateCard: rateCard,
+    affectedSubscriptionItemIds: z
+        .array(ulid)
+        .describe('The IDs of the subscription items that this rate card belongs to.'),
+})
+    .describe('A rate card for a subscription add-on.');
 export const addon = z
     .object({
     id: ulid,
@@ -4550,23 +4499,8 @@ export const subscriptionPhase = z
         .describe('The rate cards in effect for this phase, resolved to the version active at the queried time (the currently active version for the current phase, the first version for future phases, and the last version for past phases).'),
 })
     .describe("A subscription phase groups the rate cards in effect for a segment of the subscription's lifetime. Analogous to plan phases.");
-export const subscriptionEditOperation = z
-    .discriminatedUnion('type', [
-    subscriptionEditAddItem,
-    subscriptionEditRemoveItem,
-    subscriptionEditAddPhase,
-    subscriptionEditRemovePhase,
-    subscriptionEditStretchPhase,
-    subscriptionEditUnscheduleEdit,
-])
-    .describe('A single customization to apply to a running subscription. The `type` field discriminates which operation is performed.');
-export const subscriptionAddon = z
+export const subscriptionCustomPlan = z
     .object({
-    id: ulid,
-    labels: labels.optional(),
-    createdAt: dateTime,
-    updatedAt: dateTime,
-    deletedAt: dateTime.optional(),
     name: z
         .string()
         .min(1)
@@ -4577,23 +4511,20 @@ export const subscriptionAddon = z
         .max(1024)
         .optional()
         .describe('Optional description of the resource. Maximum 1024 characters.'),
-    addon: addonReference,
-    quantity: z
-        .number()
-        .int()
-        .gte(1)
-        .describe('The quantity of the add-on. Always 1 for single instance add-ons.'),
-    quantityAt: dateTime,
-    activeFrom: dateTime,
-    activeTo: dateTime.optional(),
-    timeline: z
-        .array(subscriptionAddonTimelineSegment)
-        .describe('The timeline of the add-on. The returned periods are sorted and continuous.'),
-    rateCards: z
-        .array(subscriptionAddonRateCard)
-        .describe('The rate cards of the add-on.'),
+    labels: labels.optional(),
+    currency: billingCurrencyCode,
+    billingCadence: iso8601Duration,
+    proRatingEnabled: z
+        .boolean()
+        .optional()
+        .default(true)
+        .describe('Whether pro-rating is enabled for this plan.'),
+    phases: z
+        .array(planPhase)
+        .min(1)
+        .describe('The plan phases define the pricing ramp for a subscription. A phase switch occurs only at the end of a billing period. At least one phase is required.'),
 })
-    .describe('Addon purchased with a subscription.');
+    .describe('An inline (custom) plan definition used to create or change a subscription without referencing a published plan. Mirrors the plan create shape without a key or version, since a custom plan is not persisted or versioned on its own.');
 export const plan = z
     .object({
     id: ulid,
@@ -4690,6 +4621,50 @@ export const upsertPlanRequest = z
         .describe('The plan phases define the pricing ramp for a subscription. A phase switch occurs only at the end of a billing period. At least one phase is required.'),
 })
     .describe('Plan upsert request.');
+export const subscriptionEditOperation = z
+    .discriminatedUnion('type', [
+    subscriptionEditAddItem,
+    subscriptionEditRemoveItem,
+    subscriptionEditAddPhase,
+    subscriptionEditRemovePhase,
+    subscriptionEditStretchPhase,
+    subscriptionEditUnscheduleEdit,
+])
+    .describe('A single customization to apply to a running subscription. The `type` field discriminates which operation is performed.');
+export const subscriptionAddon = z
+    .object({
+    id: ulid,
+    labels: labels.optional(),
+    createdAt: dateTime,
+    updatedAt: dateTime,
+    deletedAt: dateTime.optional(),
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('Display name of the resource. Between 1 and 256 characters.'),
+    description: z
+        .string()
+        .max(1024)
+        .optional()
+        .describe('Optional description of the resource. Maximum 1024 characters.'),
+    addon: addonReference,
+    quantity: z
+        .number()
+        .int()
+        .gte(1)
+        .describe('The quantity of the add-on. Always 1 for single instance add-ons.'),
+    quantityAt: dateTime,
+    activeFrom: dateTime,
+    activeTo: dateTime.optional(),
+    timeline: z
+        .array(subscriptionAddonTimelineSegment)
+        .describe('The timeline of the add-on. The returned periods are sorted and continuous.'),
+    rateCards: z
+        .array(subscriptionAddonRateCard)
+        .describe('The rate cards of the add-on.'),
+})
+    .describe('Addon purchased with a subscription.');
 export const addonPagePaginatedResponse = z
     .object({
     data: z.array(addon),
@@ -4746,6 +4721,65 @@ export const subscription = z
         .describe("The phases of the subscription in chronological order. A phase groups the rate cards that are in effect for a segment of the subscription's lifetime."),
 })
     .describe('Subscription.');
+export const subscriptionCreate = z.object({
+    labels: labels.optional(),
+    settlementMode: settlementMode.optional(),
+    customer: z
+        .object({
+        id: ulid.optional(),
+        key: externalResourceKey.optional(),
+    })
+        .describe('The customer to create the subscription for.'),
+    plan: z
+        .object({
+        id: ulid.optional(),
+        key: resourceKey.optional(),
+        version: z
+            .number()
+            .int()
+            .optional()
+            .describe('The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.'),
+    })
+        .optional()
+        .describe('A reference to a published plan the subscription is created from. Exactly one of `plan` or `custom_plan` must be provided. Use `plan` to base the subscription on an existing published plan; use `custom_plan` to define the plan inline.'),
+    customPlan: subscriptionCustomPlan.optional(),
+    billingAnchor: dateTime.optional(),
+    costBasisMode: subscriptionCostBasisMode.optional().default('dynamic'),
+});
+export const subscriptionChange = z
+    .object({
+    labels: labels.optional(),
+    settlementMode: settlementMode.optional(),
+    customer: z
+        .object({
+        id: ulid.optional(),
+        key: externalResourceKey.optional(),
+    })
+        .describe('The customer to create the subscription for.'),
+    plan: z
+        .object({
+        id: ulid.optional(),
+        key: resourceKey.optional(),
+        version: z
+            .number()
+            .int()
+            .optional()
+            .describe('The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.'),
+    })
+        .optional()
+        .describe('A reference to a published plan the subscription is created from. Exactly one of `plan` or `custom_plan` must be provided. Use `plan` to base the subscription on an existing published plan; use `custom_plan` to define the plan inline.'),
+    customPlan: subscriptionCustomPlan.optional(),
+    billingAnchor: dateTime.optional(),
+    costBasisMode: subscriptionCostBasisMode.optional().default('dynamic'),
+    timing: subscriptionEditTiming,
+})
+    .describe('Request for changing a subscription.');
+export const planPagePaginatedResponse = z
+    .object({
+    data: z.array(plan),
+    meta: paginatedMeta,
+})
+    .describe('Page paginated response.');
 export const subscriptionEdit = z
     .object({
     customizations: z
@@ -4761,12 +4795,6 @@ export const subscriptionAddonPagePaginatedResponse = z
     meta: paginatedMeta,
 })
     .describe('Page paginated response.');
-export const planPagePaginatedResponse = z
-    .object({
-    data: z.array(plan),
-    meta: paginatedMeta,
-})
-    .describe('Page paginated response.');
 export const invoiceStandard = z
     .object({
     id: ulid,
@@ -7887,31 +7915,6 @@ export const rateCardProrationConfigurationWire = z
     mode: rateCardProrationModeWire,
 })
     .describe('The proration configuration of the rate card.');
-export const subscriptionCreateWire = z
-    .strictObject({
-    labels: labelsWire.optional(),
-    settlement_mode: settlementModeWire.optional(),
-    customer: z
-        .strictObject({
-        id: ulidWire.optional(),
-        key: externalResourceKeyWire.optional(),
-    })
-        .describe('The customer to create the subscription for.'),
-    plan: z
-        .strictObject({
-        id: ulidWire.optional(),
-        key: resourceKeyWire.optional(),
-        version: z
-            .number()
-            .int()
-            .optional()
-            .describe('The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.'),
-    })
-        .describe('The plan reference of the subscription.'),
-    billing_anchor: dateTimeWire.optional(),
-    cost_basis_mode: subscriptionCostBasisModeWire.optional(),
-})
-    .describe('Subscription create request.');
 export const unitConfigWire = z
     .strictObject({
     operation: unitConfigOperationWire,
@@ -8865,32 +8868,6 @@ export const subscriptionCancelWire = z
     timing: subscriptionEditTimingWire.optional(),
 })
     .describe('Request for canceling a subscription.');
-export const subscriptionChangeWire = z
-    .strictObject({
-    labels: labelsWire.optional(),
-    settlement_mode: settlementModeWire.optional(),
-    customer: z
-        .strictObject({
-        id: ulidWire.optional(),
-        key: externalResourceKeyWire.optional(),
-    })
-        .describe('The customer to create the subscription for.'),
-    plan: z
-        .strictObject({
-        id: ulidWire.optional(),
-        key: resourceKeyWire.optional(),
-        version: z
-            .number()
-            .int()
-            .optional()
-            .describe('The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.'),
-    })
-        .describe('The plan reference of the subscription.'),
-    billing_anchor: dateTimeWire.optional(),
-    cost_basis_mode: subscriptionCostBasisModeWire.optional(),
-    timing: subscriptionEditTimingWire,
-})
-    .describe('Request for changing a subscription.');
 export const createSubscriptionAddonRequestWire = z
     .strictObject({
     labels: labelsWire.optional(),
@@ -9927,23 +9904,6 @@ export const subscriptionItemWire = z
     rate_card: rateCardWire,
 })
     .describe('A subscription item pins a rate card to a cadence within a subscription phase.');
-export const subscriptionEditAddItemWire = z
-    .strictObject({
-    type: z
-        .literal('add_item')
-        .describe('Discriminator for the add-item operation.'),
-    phase_key: z.string().describe('The key of the phase to add the item to.'),
-    rate_card: rateCardWire,
-})
-    .describe('Add a new rate card to a phase. Adding an item to the current phase closes the active version of the same item key and appends a new version.');
-export const subscriptionAddonRateCardWire = z
-    .strictObject({
-    rate_card: rateCardWire,
-    affected_subscription_item_ids: z
-        .array(ulidWire)
-        .describe('The IDs of the subscription items that this rate card belongs to.'),
-})
-    .describe('A rate card for a subscription add-on.');
 export const planPhaseWire = z
     .strictObject({
     name: z
@@ -9962,6 +9922,23 @@ export const planPhaseWire = z
     rate_cards: z.array(rateCardWire).describe('The rate cards of the plan.'),
 })
     .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.");
+export const subscriptionEditAddItemWire = z
+    .strictObject({
+    type: z
+        .literal('add_item')
+        .describe('Discriminator for the add-item operation.'),
+    phase_key: z.string().describe('The key of the phase to add the item to.'),
+    rate_card: rateCardWire,
+})
+    .describe('Add a new rate card to a phase. Adding an item to the current phase closes the active version of the same item key and appends a new version.');
+export const subscriptionAddonRateCardWire = z
+    .strictObject({
+    rate_card: rateCardWire,
+    affected_subscription_item_ids: z
+        .array(ulidWire)
+        .describe('The IDs of the subscription items that this rate card belongs to.'),
+})
+    .describe('A rate card for a subscription add-on.');
 export const addonWire = z
     .strictObject({
     id: ulidWire,
@@ -10205,23 +10182,8 @@ export const subscriptionPhaseWire = z
         .describe('The rate cards in effect for this phase, resolved to the version active at the queried time (the currently active version for the current phase, the first version for future phases, and the last version for past phases).'),
 })
     .describe("A subscription phase groups the rate cards in effect for a segment of the subscription's lifetime. Analogous to plan phases.");
-export const subscriptionEditOperationWire = z
-    .discriminatedUnion('type', [
-    subscriptionEditAddItemWire,
-    subscriptionEditRemoveItemWire,
-    subscriptionEditAddPhaseWire,
-    subscriptionEditRemovePhaseWire,
-    subscriptionEditStretchPhaseWire,
-    subscriptionEditUnscheduleEditWire,
-])
-    .describe('A single customization to apply to a running subscription. The `type` field discriminates which operation is performed.');
-export const subscriptionAddonWire = z
+export const subscriptionCustomPlanWire = z
     .strictObject({
-    id: ulidWire,
-    labels: labelsWire.optional(),
-    created_at: dateTimeWire,
-    updated_at: dateTimeWire,
-    deleted_at: dateTimeWire.optional(),
     name: z
         .string()
         .min(1)
@@ -10232,23 +10194,19 @@ export const subscriptionAddonWire = z
         .max(1024)
         .optional()
         .describe('Optional description of the resource. Maximum 1024 characters.'),
-    addon: addonReferenceWire,
-    quantity: z
-        .number()
-        .int()
-        .gte(1)
-        .describe('The quantity of the add-on. Always 1 for single instance add-ons.'),
-    quantity_at: dateTimeWire,
-    active_from: dateTimeWire,
-    active_to: dateTimeWire.optional(),
-    timeline: z
-        .array(subscriptionAddonTimelineSegmentWire)
-        .describe('The timeline of the add-on. The returned periods are sorted and continuous.'),
-    rate_cards: z
-        .array(subscriptionAddonRateCardWire)
-        .describe('The rate cards of the add-on.'),
+    labels: labelsWire.optional(),
+    currency: billingCurrencyCodeWire,
+    billing_cadence: iso8601DurationWire,
+    pro_rating_enabled: z
+        .boolean()
+        .optional()
+        .describe('Whether pro-rating is enabled for this plan.'),
+    phases: z
+        .array(planPhaseWire)
+        .min(1)
+        .describe('The plan phases define the pricing ramp for a subscription. A phase switch occurs only at the end of a billing period. At least one phase is required.'),
 })
-    .describe('Addon purchased with a subscription.');
+    .describe('An inline (custom) plan definition used to create or change a subscription without referencing a published plan. Mirrors the plan create shape without a key or version, since a custom plan is not persisted or versioned on its own.');
 export const planWire = z
     .strictObject({
     id: ulidWire,
@@ -10341,6 +10299,50 @@ export const upsertPlanRequestWire = z
         .describe('The plan phases define the pricing ramp for a subscription. A phase switch occurs only at the end of a billing period. At least one phase is required.'),
 })
     .describe('Plan upsert request.');
+export const subscriptionEditOperationWire = z
+    .discriminatedUnion('type', [
+    subscriptionEditAddItemWire,
+    subscriptionEditRemoveItemWire,
+    subscriptionEditAddPhaseWire,
+    subscriptionEditRemovePhaseWire,
+    subscriptionEditStretchPhaseWire,
+    subscriptionEditUnscheduleEditWire,
+])
+    .describe('A single customization to apply to a running subscription. The `type` field discriminates which operation is performed.');
+export const subscriptionAddonWire = z
+    .strictObject({
+    id: ulidWire,
+    labels: labelsWire.optional(),
+    created_at: dateTimeWire,
+    updated_at: dateTimeWire,
+    deleted_at: dateTimeWire.optional(),
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('Display name of the resource. Between 1 and 256 characters.'),
+    description: z
+        .string()
+        .max(1024)
+        .optional()
+        .describe('Optional description of the resource. Maximum 1024 characters.'),
+    addon: addonReferenceWire,
+    quantity: z
+        .number()
+        .int()
+        .gte(1)
+        .describe('The quantity of the add-on. Always 1 for single instance add-ons.'),
+    quantity_at: dateTimeWire,
+    active_from: dateTimeWire,
+    active_to: dateTimeWire.optional(),
+    timeline: z
+        .array(subscriptionAddonTimelineSegmentWire)
+        .describe('The timeline of the add-on. The returned periods are sorted and continuous.'),
+    rate_cards: z
+        .array(subscriptionAddonRateCardWire)
+        .describe('The rate cards of the add-on.'),
+})
+    .describe('Addon purchased with a subscription.');
 export const addonPagePaginatedResponseWire = z
     .strictObject({
     data: z.array(addonWire),
@@ -10397,6 +10399,65 @@ export const subscriptionWire = z
         .describe("The phases of the subscription in chronological order. A phase groups the rate cards that are in effect for a segment of the subscription's lifetime."),
 })
     .describe('Subscription.');
+export const subscriptionCreateWire = z.strictObject({
+    labels: labelsWire.optional(),
+    settlement_mode: settlementModeWire.optional(),
+    customer: z
+        .strictObject({
+        id: ulidWire.optional(),
+        key: externalResourceKeyWire.optional(),
+    })
+        .describe('The customer to create the subscription for.'),
+    plan: z
+        .strictObject({
+        id: ulidWire.optional(),
+        key: resourceKeyWire.optional(),
+        version: z
+            .number()
+            .int()
+            .optional()
+            .describe('The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.'),
+    })
+        .optional()
+        .describe('A reference to a published plan the subscription is created from. Exactly one of `plan` or `custom_plan` must be provided. Use `plan` to base the subscription on an existing published plan; use `custom_plan` to define the plan inline.'),
+    custom_plan: subscriptionCustomPlanWire.optional(),
+    billing_anchor: dateTimeWire.optional(),
+    cost_basis_mode: subscriptionCostBasisModeWire.optional(),
+});
+export const subscriptionChangeWire = z
+    .strictObject({
+    labels: labelsWire.optional(),
+    settlement_mode: settlementModeWire.optional(),
+    customer: z
+        .strictObject({
+        id: ulidWire.optional(),
+        key: externalResourceKeyWire.optional(),
+    })
+        .describe('The customer to create the subscription for.'),
+    plan: z
+        .strictObject({
+        id: ulidWire.optional(),
+        key: resourceKeyWire.optional(),
+        version: z
+            .number()
+            .int()
+            .optional()
+            .describe('The plan version of the subscription, if any. If not provided, the latest version of the plan will be used.'),
+    })
+        .optional()
+        .describe('A reference to a published plan the subscription is created from. Exactly one of `plan` or `custom_plan` must be provided. Use `plan` to base the subscription on an existing published plan; use `custom_plan` to define the plan inline.'),
+    custom_plan: subscriptionCustomPlanWire.optional(),
+    billing_anchor: dateTimeWire.optional(),
+    cost_basis_mode: subscriptionCostBasisModeWire.optional(),
+    timing: subscriptionEditTimingWire,
+})
+    .describe('Request for changing a subscription.');
+export const planPagePaginatedResponseWire = z
+    .strictObject({
+    data: z.array(planWire),
+    meta: paginatedMetaWire,
+})
+    .describe('Page paginated response.');
 export const subscriptionEditWire = z
     .strictObject({
     customizations: z
@@ -10412,12 +10473,6 @@ export const subscriptionAddonPagePaginatedResponseWire = z
     meta: paginatedMetaWire,
 })
     .describe('Page paginated response.');
-export const planPagePaginatedResponseWire = z
-    .strictObject({
-    data: z.array(planWire),
-    meta: paginatedMetaWire,
-})
-    .describe('Page paginated response.');
 export const invoiceStandardWire = z
     .strictObject({
     id: ulidWire,