Get current value model | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.valueModels.getCurrentValueModel();
}
main();

{
  "id": "d4f1a2b3-9c8e-4f7a-8b2d-1e3f4a5c6d7e",
  "version": 3,
  "content": {
    "currency": "USD",
    "valueTypes": [
      {
        "slug": "revenue",
        "name": "Revenue",
        "unit": {
          "type": "monetary"
        },
        "monetaryConversion": {
          "expression": "base_amount * exchange_rate",
          "variables": [
            {
              "id": "exchange_rate",
              "label": "Exchange Rate",
              "default": 1
            }
          ],
          "conditions": [
            {
              "field": "region",
              "operator": "eq_string",
              "value": "US",
              "result": {
                "type": "constant",
                "value": 1,
                "expression": ""
              }
            }
          ]
        },
        "description": "Total revenue generated in USD",
        "displayOrder": 1,
        "color": "#4CAF50",
        "icon": "dollar-sign"
      }
    ],
    "formulas": [
      {
        "id": "formula_001",
        "valueTypeSlug": "revenue",
        "label": "Adjusted Revenue",
        "variables": [
          {
            "id": "discount_rate",
            "label": "Discount Rate",
            "type": "number",
            "description": "Discount applied to revenue",
            "derivedFrom": {
              "sourceField": "discount_percentage",
              "targetUnit": "seconds"
            }
          }
        ],
        "expression": "revenue * (1 - discount_rate)",
        "description": "Calculates revenue adjusted by discount rate",
        "conditions": [
          {
            "field": "discount_rate",
            "operator": "gte",
            "value": 0,
            "result": {
              "type": "constant",
              "value": 0,
              "expression": ""
            }
          }
        ],
        "defaultResult": {
          "type": "constant",
          "value": 0,
          "expression": ""
        }
      }
    ],
    "signals": [
      {
        "eventName": "purchase_completed",
        "label": "Purchase Completed",
        "formulaId": "formula_001",
        "variableMapping": {
          "discount_rate": "discount_applied"
        },
        "defaults": {
          "discount_rate": 0
        },
        "segmentTableIds": [
          "segment_table_01"
        ],
        "description": "Signal triggered when a purchase is completed",
        "labels": [
          "transaction",
          "sales"
        ],
        "tags": [
          "ecommerce",
          "revenue"
        ]
      }
    ],
    "segmentTables": [
      {
        "id": "segment_table_01",
        "label": "Customer Segments",
        "segmentKeys": [
          "customer_type"
        ],
        "columns": [
          {
            "variableId": "avg_order_value",
            "label": "Average Order Value",
            "type": "number"
          }
        ],
        "rows": [
          {
            "segmentValues": {
              "customer_type": "premium"
            },
            "variables": {
              "avg_order_value": 250
            }
          },
          {
            "segmentValues": {
              "customer_type": "standard"
            },
            "variables": {
              "avg_order_value": 100
            }
          }
        ],
        "defaultRow": {
          "avg_order_value": 150
        }
      }
    ],
    "overrides": [
      {
        "id": "override_001",
        "label": "Premium Customer Override",
        "scope": {
          "customerIds": [
            "cust_12345",
            "cust_67890"
          ],
          "customerGroupIds": [
            "premium_customers"
          ]
        },
        "currency": "USD",
        "signalOverrides": {
          "purchase_completed": {
            "defaults": {
              "discount_rate": 0.05
            }
          }
        },
        "additionalSignals": [
          {
            "eventName": "premium_purchase",
            "label": "Premium Purchase",
            "formulaId": "formula_001",
            "variableMapping": {
              "discount_rate": "premium_discount"
            },
            "defaults": {
              "discount_rate": 0.1
            },
            "segmentTableIds": [
              "segment_table_01"
            ],
            "description": "Signal for purchases by premium customers",
            "labels": [
              "premium",
              "sales"
            ],
            "tags": [
              "ecommerce",
              "premium"
            ]
          }
        ],
        "monetaryConversionOverrides": {
          "revenue": {
            "variables": {
              "exchange_rate": 1
            }
          }
        }
      }
    ]
  },
  "createdAt": "2024-01-15T09:30:00Z",
  "activatedAt": "2024-01-15T09:30:00Z",
  "effectiveFrom": "2024-01-15T09:30:00Z",
  "effectiveTo": "2025-01-15T09:30:00Z"
}

Returns the current (latest active) value model for the organization.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Response

200

idstringformat: "uuid"

Value model version ID.

versioninteger

Monotonically increasing version number.

contentobject

Full value model configuration: value types, formulas, signals, and overrides.

createdAtdatetime

activatedAtdatetime or null

effectiveFromdatetime or null

effectiveTodatetime or null

Errors

404

Not Found Error

500

Internal Server Error