@openmeter/client 1.0.0-beta-75dd3b9ccc98 → 1.0.0-beta-a175676db126

package/dist/models/types.d.ts

@@ -1917,46 +1917,6 @@ export interface RateCardProrationConfiguration {
     /** The proration mode of the rate card. */
     mode: 'no_proration' | 'prorate_prices';
 }
-/** Subscription create request. */
-export interface SubscriptionCreate {
-    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.
  *
@@ -2271,17 +2231,37 @@ export interface EntitlementAccessQueryError {
 }
 /** App customer data. */
 export interface AppCustomerData {
-    /** Used if the customer has a linked Stripe app. */
-    stripe?: AppCustomerDataStripe;
-    /** Used if the customer has a linked external invoicing app. */
-    externalInvoicing?: AppCustomerDataExternalInvoicing;
+    /**
+     * Used if the customer has a linked Stripe app.
+     *
+     * Set to `null` to remove the Stripe data of the customer; omit to leave it
+     * unchanged.
+     */
+    stripe?: AppCustomerDataStripe | null;
+    /**
+     * Used if the customer has a linked external invoicing app.
+     *
+     * Set to `null` to remove the external invoicing data of the customer; omit to
+     * leave it unchanged.
+     */
+    externalInvoicing?: AppCustomerDataExternalInvoicing | null;
 }
 /** AppCustomerData upsert request. */
 export interface UpsertAppCustomerDataRequest {
-    /** Used if the customer has a linked Stripe app. */
-    stripe?: AppCustomerDataStripe;
-    /** Used if the customer has a linked external invoicing app. */
-    externalInvoicing?: AppCustomerDataExternalInvoicing;
+    /**
+     * Used if the customer has a linked Stripe app.
+     *
+     * Set to `null` to remove the Stripe data of the customer; omit to leave it
+     * unchanged.
+     */
+    stripe?: AppCustomerDataStripe | null;
+    /**
+     * Used if the customer has a linked external invoicing app.
+     *
+     * Set to `null` to remove the external invoicing data of the customer; omit to
+     * leave it unchanged.
+     */
+    externalInvoicing?: AppCustomerDataExternalInvoicing | null;
 }
 /**
  * A credit adjustment can be used to make manual adjustments to a customer's
@@ -3220,52 +3200,6 @@ export interface SubscriptionCancel {
     /** If not provided the subscription is canceled immediately. */
     timing: SubscriptionEditTiming;
 }
-/** Request for changing a subscription. */
-export interface SubscriptionChange {
-    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;
-}
 /** SubscriptionAddon create request. */
 export interface CreateSubscriptionAddonRequest {
     labels?: Labels;
@@ -4809,25 +4743,6 @@ export interface SubscriptionItem {
     /** The rate card describing what the customer gets and pays for this item. */
     rateCard: RateCard;
 }
-/**
- * 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 interface SubscriptionEditAddItem {
-    /** Discriminator for the add-item operation. */
-    type: 'add_item';
-    /** The key of the phase to add the item to. */
-    phaseKey: string;
-    /** The rate card describing what the customer gets and pays for the new item. */
-    rateCard: RateCard;
-}
-/** A rate card for a subscription add-on. */
-export interface SubscriptionAddonRateCard {
-    /** The rate card. */
-    rateCard: RateCard;
-    /** The IDs of the subscription items that this rate card belongs to. */
-    affectedSubscriptionItemIds: string[];
-}
 /**
  * The plan phase or pricing ramp allows changing a plan's rate cards over time as
  * a subscription progresses.
@@ -4855,6 +4770,25 @@ export interface PlanPhase {
     /** The rate cards of the plan. */
     rateCards: RateCard[];
 }
+/**
+ * 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 interface SubscriptionEditAddItem {
+    /** Discriminator for the add-item operation. */
+    type: 'add_item';
+    /** The key of the phase to add the item to. */
+    phaseKey: string;
+    /** The rate card describing what the customer gets and pays for the new item. */
+    rateCard: RateCard;
+}
+/** A rate card for a subscription add-on. */
+export interface SubscriptionAddonRateCard {
+    /** The rate card. */
+    rateCard: RateCard;
+    /** The IDs of the subscription items that this rate card belongs to. */
+    affectedSubscriptionItemIds: string[];
+}
 /**
  * Add-on allows extending subscriptions with compatible plans with additional
  * ratecards.
@@ -5272,16 +5206,12 @@ export interface SubscriptionPhase {
      */
     items: SubscriptionItem[];
 }
-/** Addon purchased with a subscription. */
-export interface SubscriptionAddon {
-    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;
+/**
+ * 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 interface SubscriptionCustomPlan {
     /**
      * Display name of the resource.
      *
@@ -5294,23 +5224,18 @@ export interface SubscriptionAddon {
      * Maximum 1024 characters.
      */
     description?: string;
-    /** The add-on associated with the subscription. */
-    addon: AddonReference;
-    /** The quantity of the add-on. Always 1 for single instance add-ons. */
-    quantity: number;
+    labels?: Labels;
+    /** The currency code of the plan. */
+    currency: BillingCurrencyCode;
+    /** The billing cadence for subscriptions using this plan. */
+    billingCadence: string;
+    /** Whether pro-rating is enabled for this plan. */
+    proRatingEnabled: boolean;
     /**
-     * An ISO-8601 timestamp representation of which point in time the quantity was
-     * resolved to.
+     * 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.
      */
-    quantityAt: Date;
-    /** An ISO-8601 timestamp representation of the cadence start of the resource. */
-    activeFrom: Date;
-    /** An ISO-8601 timestamp representation of the cadence end of the resource. */
-    activeTo?: Date;
-    /** The timeline of the add-on. The returned periods are sorted and continuous. */
-    timeline: SubscriptionAddonTimelineSegment[];
-    /** The rate cards of the add-on. */
-    rateCards: SubscriptionAddonRateCard[];
+    phases: PlanPhase[];
 }
 /** Plans provide a template for subscriptions. */
 export interface Plan {
@@ -5448,6 +5373,46 @@ export interface UpsertPlanRequest {
      */
     phases: PlanPhase[];
 }
+/** Addon purchased with a subscription. */
+export interface SubscriptionAddon {
+    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;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    /** The add-on associated with the subscription. */
+    addon: AddonReference;
+    /** The quantity of the add-on. Always 1 for single instance add-ons. */
+    quantity: number;
+    /**
+     * An ISO-8601 timestamp representation of which point in time the quantity was
+     * resolved to.
+     */
+    quantityAt: Date;
+    /** An ISO-8601 timestamp representation of the cadence start of the resource. */
+    activeFrom: Date;
+    /** An ISO-8601 timestamp representation of the cadence end of the resource. */
+    activeTo?: Date;
+    /** The timeline of the add-on. The returned periods are sorted and continuous. */
+    timeline: SubscriptionAddonTimelineSegment[];
+    /** The rate cards of the add-on. */
+    rateCards: SubscriptionAddonRateCard[];
+}
 /** Page paginated response. */
 export interface AddonPagePaginatedResponse {
     data: Addon[];
@@ -5544,47 +5509,160 @@ export interface Subscription {
      */
     phases: SubscriptionPhase[];
 }
-/**
- * Request for editing a running subscription. Applies an ordered batch of
- * customizations to the subscription's phases and items. A later customization
- * observes the state produced by earlier ones.
- */
-export interface SubscriptionEdit {
-    /** The ordered batch of customizations to apply to the running subscription. */
-    customizations: SubscriptionEditOperation[];
-    /** When the requested changes should take effect. Defaults to immediate. */
-    timing: SubscriptionEditTiming;
-}
-/** Page paginated response. */
-export interface SubscriptionAddonPagePaginatedResponse {
-    data: SubscriptionAddon[];
-    meta: PaginatedMeta;
-}
-/** Page paginated response. */
-export interface PlanPagePaginatedResponse {
-    data: Plan[];
-    meta: PaginatedMeta;
-}
-/** A standard invoice for charges owed by the customer. */
-export interface InvoiceStandard {
-    id: string;
+export interface SubscriptionCreate {
+    labels?: Labels;
     /**
-     * Optional description of the resource.
+     * Settlement mode for billing.
      *
-     * Maximum 1024 characters.
+     * Values:
+     *
+     * - `credit_then_invoice`: Credits are applied first, then any remainder is
+     * invoiced.
+     * - `credit_only`: Usage is settled exclusively against credits.
      */
-    description?: 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;
-    /** Human-readable invoice number generated by the invoicing app. */
-    number: string;
-    /** Three-letter ISO 4217 currency code for the invoice. */
-    currency: string;
+    settlementMode?: 'credit_then_invoice' | 'credit_only';
+    /** The customer to create the subscription for. */
+    customer: {
+        id?: string;
+        key?: string;
+    };
+    /**
+     * 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.
+     */
+    plan?: {
+        id?: string;
+        key?: string;
+        version?: number;
+    };
+    /**
+     * An inline plan definition to create the subscription from, without referencing a
+     * published plan.
+     *
+     * Exactly one of `plan` or `custom_plan` must be provided. The subscription is not
+     * linked to a persisted plan, so the response omits the `plan` reference.
+     */
+    customPlan?: SubscriptionCustomPlan;
+    /**
+     * 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';
+}
+/** Request for changing a subscription. */
+export interface SubscriptionChange {
+    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;
+    };
+    /**
+     * 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.
+     */
+    plan?: {
+        id?: string;
+        key?: string;
+        version?: number;
+    };
+    /**
+     * An inline plan definition to create the subscription from, without referencing a
+     * published plan.
+     *
+     * Exactly one of `plan` or `custom_plan` must be provided. The subscription is not
+     * linked to a persisted plan, so the response omits the `plan` reference.
+     */
+    customPlan?: SubscriptionCustomPlan;
+    /**
+     * 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;
+}
+/** Page paginated response. */
+export interface PlanPagePaginatedResponse {
+    data: Plan[];
+    meta: PaginatedMeta;
+}
+/**
+ * Request for editing a running subscription. Applies an ordered batch of
+ * customizations to the subscription's phases and items. A later customization
+ * observes the state produced by earlier ones.
+ */
+export interface SubscriptionEdit {
+    /** The ordered batch of customizations to apply to the running subscription. */
+    customizations: SubscriptionEditOperation[];
+    /** When the requested changes should take effect. Defaults to immediate. */
+    timing: SubscriptionEditTiming;
+}
+/** Page paginated response. */
+export interface SubscriptionAddonPagePaginatedResponse {
+    data: SubscriptionAddon[];
+    meta: PaginatedMeta;
+}
+/** A standard invoice for charges owed by the customer. */
+export interface InvoiceStandard {
+    id: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: 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;
+    /** Human-readable invoice number generated by the invoicing app. */
+    number: string;
+    /** Three-letter ISO 4217 currency code for the invoice. */
+    currency: string;
     /**
      * Snapshot of the supplier's contact information at the time the invoice was
      * issued.
@@ -6341,46 +6419,6 @@ 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.
  *
@@ -6493,52 +6531,6 @@ 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.
  *
@@ -7238,25 +7230,6 @@ export interface SubscriptionItemInput {
     /** The rate card describing what the customer gets and pays for this item. */
     rateCard: RateCardInput;
 }
-/**
- * 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 interface SubscriptionEditAddItemInput {
-    /** Discriminator for the add-item operation. */
-    type: 'add_item';
-    /** The key of the phase to add the item to. */
-    phaseKey: string;
-    /** The rate card describing what the customer gets and pays for the new item. */
-    rateCard: RateCardInput;
-}
-/** A rate card for a subscription add-on. */
-export interface SubscriptionAddonRateCardInput {
-    /** The rate card. */
-    rateCard: RateCardInput;
-    /** The IDs of the subscription items that this rate card belongs to. */
-    affectedSubscriptionItemIds: string[];
-}
 /**
  * The plan phase or pricing ramp allows changing a plan's rate cards over time as
  * a subscription progresses.
@@ -7284,6 +7257,25 @@ export interface PlanPhaseInput {
     /** The rate cards of the plan. */
     rateCards: RateCardInput[];
 }
+/**
+ * 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 interface SubscriptionEditAddItemInput {
+    /** Discriminator for the add-item operation. */
+    type: 'add_item';
+    /** The key of the phase to add the item to. */
+    phaseKey: string;
+    /** The rate card describing what the customer gets and pays for the new item. */
+    rateCard: RateCardInput;
+}
+/** A rate card for a subscription add-on. */
+export interface SubscriptionAddonRateCardInput {
+    /** The rate card. */
+    rateCard: RateCardInput;
+    /** The IDs of the subscription items that this rate card belongs to. */
+    affectedSubscriptionItemIds: string[];
+}
 /**
  * Add-on allows extending subscriptions with compatible plans with additional
  * ratecards.
@@ -7659,16 +7651,12 @@ export interface SubscriptionPhaseInput {
      */
     items: SubscriptionItemInput[];
 }
-/** Addon purchased with a subscription. */
-export interface SubscriptionAddonInput {
-    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;
+/**
+ * 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 interface SubscriptionCustomPlanInput {
     /**
      * Display name of the resource.
      *
@@ -7681,23 +7669,18 @@ export interface SubscriptionAddonInput {
      * Maximum 1024 characters.
      */
     description?: string;
-    /** The add-on associated with the subscription. */
-    addon: AddonReference;
-    /** The quantity of the add-on. Always 1 for single instance add-ons. */
-    quantity: number;
+    labels?: Labels;
+    /** The currency code of the plan. */
+    currency: BillingCurrencyCode;
+    /** The billing cadence for subscriptions using this plan. */
+    billingCadence: string;
+    /** Whether pro-rating is enabled for this plan. */
+    proRatingEnabled?: boolean;
     /**
-     * An ISO-8601 timestamp representation of which point in time the quantity was
-     * resolved to.
+     * 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.
      */
-    quantityAt: Date;
-    /** An ISO-8601 timestamp representation of the cadence start of the resource. */
-    activeFrom: Date;
-    /** An ISO-8601 timestamp representation of the cadence end of the resource. */
-    activeTo?: Date;
-    /** The timeline of the add-on. The returned periods are sorted and continuous. */
-    timeline: SubscriptionAddonTimelineSegment[];
-    /** The rate cards of the add-on. */
-    rateCards: SubscriptionAddonRateCardInput[];
+    phases: PlanPhaseInput[];
 }
 /** Plans provide a template for subscriptions. */
 export interface PlanInput {
@@ -7835,6 +7818,46 @@ export interface UpsertPlanRequestInput {
      */
     phases: PlanPhaseInput[];
 }
+/** Addon purchased with a subscription. */
+export interface SubscriptionAddonInput {
+    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;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    /** The add-on associated with the subscription. */
+    addon: AddonReference;
+    /** The quantity of the add-on. Always 1 for single instance add-ons. */
+    quantity: number;
+    /**
+     * An ISO-8601 timestamp representation of which point in time the quantity was
+     * resolved to.
+     */
+    quantityAt: Date;
+    /** An ISO-8601 timestamp representation of the cadence start of the resource. */
+    activeFrom: Date;
+    /** An ISO-8601 timestamp representation of the cadence end of the resource. */
+    activeTo?: Date;
+    /** The timeline of the add-on. The returned periods are sorted and continuous. */
+    timeline: SubscriptionAddonTimelineSegment[];
+    /** The rate cards of the add-on. */
+    rateCards: SubscriptionAddonRateCardInput[];
+}
 /** Page paginated response. */
 export interface AddonPagePaginatedResponseInput {
     data: AddonInput[];
@@ -7931,6 +7954,124 @@ export interface SubscriptionInput {
      */
     phases: SubscriptionPhaseInput[];
 }
+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;
+    };
+    /**
+     * 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.
+     */
+    plan?: {
+        id?: string;
+        key?: string;
+        version?: number;
+    };
+    /**
+     * An inline plan definition to create the subscription from, without referencing a
+     * published plan.
+     *
+     * Exactly one of `plan` or `custom_plan` must be provided. The subscription is not
+     * linked to a persisted plan, so the response omits the `plan` reference.
+     */
+    customPlan?: SubscriptionCustomPlanInput;
+    /**
+     * 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';
+}
+/** 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;
+    };
+    /**
+     * 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.
+     */
+    plan?: {
+        id?: string;
+        key?: string;
+        version?: number;
+    };
+    /**
+     * An inline plan definition to create the subscription from, without referencing a
+     * published plan.
+     *
+     * Exactly one of `plan` or `custom_plan` must be provided. The subscription is not
+     * linked to a persisted plan, so the response omits the `plan` reference.
+     */
+    customPlan?: SubscriptionCustomPlanInput;
+    /**
+     * 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;
+}
+/** Page paginated response. */
+export interface PlanPagePaginatedResponseInput {
+    data: PlanInput[];
+    meta: PaginatedMeta;
+}
 /**
  * Request for editing a running subscription. Applies an ordered batch of
  * customizations to the subscription's phases and items. A later customization
@@ -7947,11 +8088,6 @@ export interface SubscriptionAddonPagePaginatedResponseInput {
     data: SubscriptionAddonInput[];
     meta: PaginatedMeta;
 }
-/** Page paginated response. */
-export interface PlanPagePaginatedResponseInput {
-    data: PlanInput[];
-    meta: PaginatedMeta;
-}
 /** A standard invoice for charges owed by the customer. */
 export interface InvoiceStandardInput {
     id: string;