Overview

Use Case versioning allows you to effectively track and manage the evolution of your Use Case implementations over time. Pay-i uses versioning to let you clearly distinguish between different versions of your Use Case implementations, enabling data-driven decisions to optimize your product based on your specific business KPIs.

How Versioning Works

• When you create a new Use Case Type using the Create Use Case API, it automatically begins at v1.
• Versions increment sequentially (1, 2, 3, etc.) and are managed explicitly through the Increment Use Case Version API. Note, the ability to increment versions from the Pay-i dashboard is coming soon.
• Version increment is not triggered when:
  • The use case type description or name is updated via the Update Use Case API.
  • The default limits are updated via the Create Use Case Limit Config API.
• Each new version inherits all properties from the previous version, including Name, Description, LoggingEnabled, and LimitConfig.
• Instances are tagged with the latest version number by default.
• In scenarios where multiple versions are simultaneously active, you can explicitly specify the desired use case version via xProxy-UseCase-Version header, both while using the Request Ingest API as well as the proxy.

Viewing Versions in the Dashboard

Use Case versions are displayed and managed across various sections of the Pay-i portal. Specifically, versions are displayed in:

• Time Series: Versions within the selected time window are indicated by dotted lines marking transitions.
• Table: Includes a dedicated "Version" column listing versions active during the selected period.
• Histogram: When you select a use case type, the histogram reflects data only from the selected version, clearly labeled (e.g., "Use Case Name (v3)").
• Regressions: Displayed with the highest version at the start of the selected time window and the highest version at the end of the window (e.g., "v2 → v3"). Version changes do not affect regression calculations.

The use case version selector defaults to the highest version active during your selected time period. You can choose from any version active within your selected timeframe.

Versioning Impact on Regressions and Forecasts

Pay-i does not use use case versions when calculating regressions and forecasts. It visually indicates version increments on the timeline as annotations to clearly represent the evolution of use cases over time.