Metrics

Calculate metrics from order data

post

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

effectiveStartDatestring · date-time · nullableOptional

effectiveEndDatestring · date-time · nullableOptional

terminteger · int32 · nullableOptional

orderTypestring · enumOptionalPossible values:

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post/Metrics/CalculateMetrics/Order

HTTPcURLJavaScriptPython

POST /Metrics/CalculateMetrics/Order HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1056

{
  "effectiveStartDate": "2026-07-20T08:26:32.477Z",
  "effectiveEndDate": "2026-07-20T08:26:32.477Z",
  "term": 1,
  "orderType": "Subscription",
  "currency": "SEK",
  "account": "A-000001",
  "products": [
    {
      "product": "P-000001",
      "chargePlan": "CP-000001",
      "charges": [
        {
          "charge": {
            "key": "text",
            "value": "text"
          },
          "name": "text",
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "quantity": 1,
          "pricePeriod": "Monthly",
          "billingPeriod": "Monthly",
          "effectiveStartDate": "2026-07-20T08:26:32.477Z",
          "effectiveEndDate": "2026-07-20T08:26:32.477Z",
          "taxTemplate": "Sweden standard",
          "taxIncluded": true,
          "priceDetails": [
            {
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "lineDiscountAmount": 1,
              "lineDiscountPercent": 1,
              "toQuantity": 1,
              "isInfinite": true,
              "priceBase": "Flat"
            }
          ],
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "orderDiscountMappingKey": [
            "text"
          ]
        }
      ]
    }
  ],
  "orderDiscounts": [
    {
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2026-07-20T08:26:32.477Z",
      "endDate": "2026-07-20T08:26:32.477Z",
      "percent": 1,
      "description": "text",
      "onSpecificCharges": true,
      "charges": [
        {
          "charge": {
            "key": "text",
            "value": "text"
          }
        }
      ],
      "chargeMappingKey": "text"
    }
  ]
}

{
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "fmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "charges": [
    {
      "name": "text",
      "chargeNumber": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
      "chargeId": "123e4567-e89b-12d3-a456-426614174000",
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-07-20T08:26:32.477Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-07-20T08:26:32.477Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-07-20T08:26:32.477Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-07-20T08:26:32.477Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-07-20T08:26:32.477Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "fmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-07-20T08:26:32.477Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ]
}

Calculate metrics from charge data

post

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

terminteger · int32 · nullableOptional

namestring · nullableOptional

chargeTypestring · enumOptionalPossible values:

priceModelstring · enumOptionalPossible values:

quantitynumber · double · nullableOptional

pricePeriodstring · enumOptionalPossible values:

billingPeriodstring · enumOptionalPossible values:

effectiveStartDatestring · date-time · nullableOptional

effectiveEndDatestring · date-time · nullableOptional

taxIncludedboolean · nullableOptional

estimatedUsageinteger · int32 · nullableOptional

estimatedQuantityinteger · int32 · nullableOptional

Responses

200

Success

application/json

namestring · nullableOptional

chargeNumberstring · nullableOptional

idstring · uuid · nullableOptional

chargePlanIdstring · uuid · nullableOptional

orderProductIdstring · uuid · nullableOptional

chargeIdstring · uuid · nullableOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post/Metrics/CalculateMetrics/Charge

HTTPcURLJavaScriptPython

POST /Metrics/CalculateMetrics/Charge HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 543

{
  "term": 1,
  "currency": "SEK",
  "account": "A-000001",
  "charge": {
    "key": "text",
    "value": "text"
  },
  "name": "text",
  "chargeType": "OneOff",
  "priceModel": "Flat",
  "quantity": 1,
  "pricePeriod": "Monthly",
  "billingPeriod": "Monthly",
  "effectiveStartDate": "2026-07-20T08:26:32.477Z",
  "effectiveEndDate": "2026-07-20T08:26:32.477Z",
  "taxTemplate": "Sweden standard",
  "taxIncluded": true,
  "priceDetails": [
    {
      "tier": 1,
      "price": 1,
      "listPrice": 1,
      "lineDiscountAmount": 1,
      "lineDiscountPercent": 1,
      "toQuantity": 1,
      "isInfinite": true,
      "priceBase": "Flat"
    }
  ],
  "estimatedUsage": 1,
  "estimatedQuantity": 1
}

{
  "name": "text",
  "chargeNumber": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
  "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
  "chargeId": "123e4567-e89b-12d3-a456-426614174000",
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "fmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-07-20T08:26:32.477Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

---