--- title: "Migrate subscription" method: POST path: "/api/v1/subscriptions/{subscriptionId}/migrate" tags: ["Subscriptions"] --- # Migrate subscription `POST /api/v1/subscriptions/{subscriptionId}/migrate` Migrates the subscripiton to the provided version of the current plan. If possible, the migration will be done immediately. If not, the migration will be scheduled to the end of the current billing period. ## Path parameters - `subscriptionId` string, required ## Request body - object - `timing` union — 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. - 'immediate' | 'next_billing_cycle' — Subscription edit timing. When immediate, the requested changes take effect immediately. When nextBillingCycle, the requested changes take effect at the next billing cycle. - string, date-time — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC. - `targetVersion` integer — The version of the plan to migrate to. If not provided, the subscription will migrate to the latest version of the current plan. - `startingPhase` string — The key of the phase to start the subscription in. If not provided, the subscription will start in the first phase of the plan. - `billingAnchor` string, date-time — The billing anchor of the subscription. The provided date will be normalized according to the billing cadence to the nearest recurrence before start time. If not provided, the previous subscription billing anchor will be used. ## Response `200` The request has succeeded. - SubscriptionChangeResponseBody — Response body for subscription change. - `current` Subscription, required — Subscription is an exact subscription instance. - `id` string, required — A unique identifier for the resource. - `name` string, required — Human-readable name for the resource. Between 1 and 256 characters. - `description` string — Optional description of the resource. Maximum 1024 characters. - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource. - `createdAt` string, date-time, required — Timestamp of when the resource was created. - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated. - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted. - `activeFrom` string, date-time, required — The cadence start of the resource. - `activeTo` string, date-time — The cadence end of the resource. - `annotations` Annotations — Set of key-value pairs managed by the system. Cannot be modified by user. - `alignment` Alignment — Alignment configuration for a plan or subscription. - `billablesMustAlign` boolean — Whether all Billable items and RateCards must align. Alignment means the Price's BillingCadence must align for both duration and anchor time. - `status` 'active' | 'inactive' | 'canceled' | 'scheduled', required — Subscription status. - `customerId` string, required — The customer ID of the subscription. - `plan` PlanReference — References an exact plan. - `id` string, required — The plan ID. - `key` string, required — The plan key. - `version` integer, required — The plan version. - `currency` string, required — Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience. - `billingCadence` string, duration, required — The billing cadence for the subscriptions. Defines how often customers are billed using ISO8601 duration format. Examples: "P1M" (monthly), "P3M" (quarterly), "P1Y" (annually). - `proRatingConfig` ProRatingConfig — Configuration for pro-rating behavior. - `enabled` boolean, required — Whether pro-rating is enabled for this plan. - `mode` 'prorate_prices', required — Pro-rating mode options for handling billing period changes. - `billingAnchor` string, date-time, required — The normalizedbilling anchor of the subscription. - `settlementMode` 'credit_then_invoice' | 'credit_only', required — The settlement mode of a plan. It determines how the billing system generates invoices and credits for the subscriptions using this plan. - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode. - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription. - `next` SubscriptionExpanded, required — Expanded subscription - `id` string, required — A unique identifier for the resource. - `name` string, required — Human-readable name for the resource. Between 1 and 256 characters. - `description` string — Optional description of the resource. Maximum 1024 characters. - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource. - `createdAt` string, date-time, required — Timestamp of when the resource was created. - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated. - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted. - `activeFrom` string, date-time, required — The cadence start of the resource. - `activeTo` string, date-time — The cadence end of the resource. - `annotations` Annotations — Set of key-value pairs managed by the system. Cannot be modified by user. - `status` 'active' | 'inactive' | 'canceled' | 'scheduled', required — Subscription status. - `customerId` string, required — The customer ID of the subscription. - `plan` PlanReference — References an exact plan. - `id` string, required — The plan ID. - `key` string, required — The plan key. - `version` integer, required — The plan version. - `currency` string, required — Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience. - `billingCadence` string, duration, required — The billing cadence for the subscriptions. Defines how often customers are billed using ISO8601 duration format. Examples: "P1M" (monthly), "P3M" (quarterly), "P1Y" (annually). - `proRatingConfig` ProRatingConfig — Configuration for pro-rating behavior. - `enabled` boolean, required — Whether pro-rating is enabled for this plan. - `mode` 'prorate_prices', required — Pro-rating mode options for handling billing period changes. - `billingAnchor` string, date-time, required — The normalizedbilling anchor of the subscription. - `settlementMode` 'credit_then_invoice' | 'credit_only', required — The settlement mode of a plan. It determines how the billing system generates invoices and credits for the subscriptions using this plan. - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode. - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription. - `alignment` SubscriptionAlignment — Alignment details enriched with the current billing period. - `billablesMustAlign` boolean — Whether all Billable items and RateCards must align. Alignment means the Price's BillingCadence must align for both duration and anchor time. - `currentAlignedBillingPeriod` Period — A period with a start and end time. - `from` string, date-time, required — Period start time. - `to` string, date-time, required — Period end time. - `phases` SubscriptionPhaseExpanded[], required — The phases of the subscription. - `id` string, required — A unique identifier for the resource. - `name` string, required — Human-readable name for the resource. Between 1 and 256 characters. - `description` string — Optional description of the resource. Maximum 1024 characters. - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource. - `createdAt` string, date-time, required — Timestamp of when the resource was created. - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated. - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted. - `key` string, required — A locally unique identifier for the resource. - `discounts` Discounts — Discount by type on a price - `percentage` DiscountPercentage — Percentage discount. - `percentage` number, double, required — Numeric representation of a percentage 50% is represented as 50 - `usage` DiscountUsage — Usage discount. Usage discount means that the first N items are free. From billing perspective this means that any usage on a specific feature is considered 0 until this discount is exhausted. - `quantity` string, required — Numeric represents an arbitrary precision number. - `activeFrom` string, date-time, required — The time from which the phase is active. - `activeTo` string, date-time — The until which the Phase is active. - `items` SubscriptionItem[], required — The items of the phase. The structure is flattened to better conform to the Plan API. The timelines are flattened according to the following rules: - for the current phase, the `items` contains only the active item for each key - for past phases, the `items` contains only the last item for each key - for future phases, the `items` contains only the first version of the item for each key - `id` string, required — A unique identifier for the resource. - `name` string, required — Human-readable name for the resource. Between 1 and 256 characters. - `description` string — Optional description of the resource. Maximum 1024 characters. - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource. - `createdAt` string, date-time, required — Timestamp of when the resource was created. - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated. - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted. - `activeFrom` string, date-time, required — The cadence start of the resource. - `activeTo` string, date-time — The cadence end of the resource. - `key` string, required — The identifier of the RateCard. SubscriptionItem/RateCard can be identified, it has a reference: 1. If a Feature is associated with the SubscriptionItem, it is identified by the Feature 1.1 It can be an ID reference, for an exact version of the Feature (Features can change across versions) 1.2 It can be a Key reference, which always refers to the latest (active or inactive) version of a Feature 2. If a Feature is not associated with the SubscriptionItem, it is referenced by the Price We say "referenced by the Price" regardless of how a price itself is referenced, it colloquially makes sense to say "paying the same price for the same thing". In practice this should be derived from what's printed on the invoice line-item. - `featureKey` string — The feature's key (if present). - `billingCadence` string, duration, nullable, required — The billing cadence of the rate card. When null, the rate card is a one-time purchase. - `price` union, required — The price of the usage based rate card. - object — Flat price with payment term. - `type` 'flat', required — The type of the price. - `amount` string, required — Numeric represents an arbitrary precision number. - `paymentTerm` 'in_advance' | 'in_arrears' — The payment term of a flat price. One of: in_advance or in_arrears. - object — Unit price with spend commitments. - `type` 'unit', required — The type of the price. - `amount` string, required — Numeric represents an arbitrary precision number. - `minimumAmount` string — Numeric represents an arbitrary precision number. - `maximumAmount` string — Numeric represents an arbitrary precision number. - object — Tiered price with spend commitments. - `type` 'tiered', required — The type of the price. One of: flat, unit, or tiered. - `mode` 'volume' | 'graduated', required — The mode of the tiered price. - `tiers` PriceTier[], required — The tiers of the tiered price. At least one price component is required in each tier. - … - `minimumAmount` string — Numeric represents an arbitrary precision number. - `maximumAmount` string — Numeric represents an arbitrary precision number. - object — Dynamic price with spend commitments. - `type` 'dynamic', required — The type of the price. - `multiplier` string — Numeric represents an arbitrary precision number. - `minimumAmount` string — Numeric represents an arbitrary precision number. - `maximumAmount` string — Numeric represents an arbitrary precision number. - object — Package price with spend commitments. - `type` 'package', required — The type of the price. - `amount` string, required — Numeric represents an arbitrary precision number. - `quantityPerPackage` string, required — Numeric represents an arbitrary precision number. - `minimumAmount` string — Numeric represents an arbitrary precision number. - `maximumAmount` string — Numeric represents an arbitrary precision number. - `discounts` Discounts — Discount by type on a price - `percentage` DiscountPercentage — Percentage discount. - `percentage` number, double, required — Numeric representation of a percentage 50% is represented as 50 - `usage` DiscountUsage — Usage discount. Usage discount means that the first N items are free. From billing perspective this means that any usage on a specific feature is considered 0 until this discount is exhausted. - `quantity` string, required — Numeric represents an arbitrary precision number. - `included` SubscriptionItemIncluded — Included contents like Entitlement, or the Feature. - `feature` Feature, required — Represents a feature that can be enabled or disabled for a plan. Used both for product catalog and entitlements. - `createdAt` string, date-time, required — Timestamp of when the resource was created. - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated. - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted. - `archivedAt` string, date-time — Timestamp of when the resource was archived. - `key` string, required — A key is a unique string that is used to identify a resource. - `name` string, required - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource. - `meterSlug` string — A key is a unique string that is used to identify a resource. - `meterGroupByFilters` object — Optional meter group by filters. Useful if the meter scope is broader than what feature tracks. Example scenario would be a meter tracking all token use with groupBy fields for the model, then the feature could filter for model=gpt-4. ⚠️ __Deprecated__: Use advancedMeterGroupByFilters instead - `advancedMeterGroupByFilters` object — Optional advanced meter group by filters. You can use this to filter for values of the meter groupBy fields. - `unitCost` union — Per-unit cost configuration for a feature. Either a fixed manual amount or a dynamic LLM cost lookup. - … - `id` string, required — Readonly unique ULID identifier. - `entitlement` union — Entitlement templates are used to define the entitlements of a plan. Features are omitted from the entitlement template, as they are defined in the rate card. - object — Metered entitlements are useful for many different use cases, from setting up usage based access to implementing complex credit systems. Access is determined based on feature usage using a balance calculation (the "usage allowance" provided by the issued grants is "burnt down" by the usage). - … - object — A static entitlement. - … - object — Entitlement template of a boolean entitlement. - … - `taxConfig` TaxConfig — Set of provider specific tax configs. - `behavior` 'inclusive' | 'exclusive' — Tax behavior. This enum is used to specify whether tax is included in the price or excluded from the price. - `stripe` StripeTaxConfig — The tax config for Stripe. - `code` string, required — Product tax code. See: https://docs.stripe.com/tax/tax-codes - `customInvoicing` CustomInvoicingTaxConfig — Custom invoicing tax config. - `code` string, required — Tax code. The tax code should be interpreted by the custom invoicing provider. - `taxCodeId` string — Tax code reference. When both `taxCodeId` and `stripe.code` are provided, `taxCodeId` takes precedence: the referenced tax code entity is used and `stripe.code` is ignored. - `itemTimelines` object, required — Includes all versions of the items on each key, including all edits, scheduled changes, etc... ## Other responses - `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). Variants with ErrorExtensions specific to subscriptions. - `401` — The request has not been applied because it lacks valid authentication credentials for the target resource. - `403` — The server understood the request but refuses to authorize it. - `404` — The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. - `409` — The request could not be completed due to a conflict with the current state of the target resource. Variants with ErrorExtensions specific to subscriptions. - `412` — One or more conditions given in the request header fields evaluated to false when tested on the server. - `500` — The server encountered an unexpected condition that prevented it from fulfilling the request. - `503` — The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. - `default` — An unexpected error response. --- [API](https://skmtc.net/openmeterio/apis/openmeter-api.md) · [All operations](https://skmtc.net/openmeterio/apis/openmeter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openmeterio/openmeter-api/versions/927d82ffe647/schema)