Subscriptionproductcharges

get

Get metrics by subscription product charge id

Path parameters

idstring · uuidRequired

Header parameters

AuthorizationanyRequired

Legal-EntityanyRequired

Responses

200

OK

application/json

baseCurrencyCodestring · nullableOptional

currencyConversionDatestring · date-time · nullableOptional

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

404

Not Found

application/problem+json

500

Internal Server Error

application/problem+json

get/subscription-product-charges/{id}/metrics

GET /subscription-product-charges/{id}/metrics HTTP/1.1
Accept: */*

[
  {
    "baseCurrencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "cmrr": {
      "amount": 1,
      "currency": "text",
      "baseCurrencyAmount": 1
    },
    "emrr": {
      "amount": 1,
      "currency": "text",
      "baseCurrencyAmount": 1
    },
    "carr": {
      "amount": 1,
      "currency": "text",
      "baseCurrencyAmount": 1
    },
    "oneTimeFees": {
      "amount": 1,
      "currency": "text",
      "baseCurrencyAmount": 1
    },
    "tcv": {
      "amount": 1,
      "currency": "text",
      "baseCurrencyAmount": 1
    }
  }
]

get

Get subscription product charges

Query parameters

allVersionsbooleanOptional

subscriptionModifiedAfterstring · date-timeRequired

subscriptionModifiedBeforestring · date-timeRequired

pageSizeinteger · int32Optional

pageNumberinteger · int32Optional

statusstring · enumOptionalPossible values:

Header parameters

AuthorizationanyRequired

Legal-EntityanyRequired

Responses

200

OK

application/json

nextPagestring · nullableRead-onlyOptional

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

404

Not Found

application/problem+json

500

Internal Server Error

application/problem+json

get/subscription-product-charges

GET /subscription-product-charges?subscriptionModifiedAfter=2026-01-01T00%3A00%3A00.000Z&subscriptionModifiedBefore=2026-01-01T00%3A00%3A00.000Z HTTP/1.1
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created": "2026-01-01T00:00:00.000Z",
      "modified": "2026-01-01T00:00:00.000Z",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "lastVersion": true,
      "chargeId": "123e4567-e89b-12d3-a456-426614174000",
      "chargeNumber": "text",
      "version": 1,
      "name": "text",
      "chargeType": "OneOff",
      "priceModel": "Flat",
      "effectiveStartDate": "2026-01-01",
      "effectiveEndDate": "2026-01-01",
      "quantity": 1,
      "startOn": "AlignToSubscription",
      "endOn": "AlignToSubscription",
      "invoicedToDate": "2026-01-01",
      "lastRenewalDate": "2026-01-01",
      "lastPriceAdjustmentDate": "2026-01-01",
      "pricePeriod": "Monthly",
      "usageRating": "Sum",
      "billingDay": "None",
      "specificBillingDay": 1,
      "billingPeriod": "Monthly",
      "billingTiming": "InAdvance",
      "periodAlignment": "None",
      "alignmentDate": "2026-01-01",
      "taxIncluded": true,
      "invoiceLinesPerTier": true,
      "estimatedUsage": 1,
      "estimatedQuantity": 1,
      "remainingQuantity": 1,
      "orderedQuantity": 1,
      "remarks": "text",
      "taxTemplate": "text",
      "unitCode": "text",
      "revenueRecognitionRule": "text",
      "deferredRevenueAccount": "text",
      "recognizedRevenueAccount": "text",
      "changeState": "NotChanged",
      "recurringMonthlyAmount": 1,
      "recurringMonthlyAmountBase": 1,
      "externalERPId": "text",
      "externalCRMId": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "features": [
        {
          "code": "text",
          "description": "text"
        }
      ],
      "details": "text",
      "metrics": "text"
    }
  ],
  "nextPage": "text"
}

get

Get subscription product charge details by charge id

Path parameters

idstring · uuidRequired

Header parameters

AuthorizationanyRequired

Legal-EntityanyRequired

Responses

200

OK

application/json

tierinteger · int32Optional

pricenumber · double · nullableOptional

listPricenumber · double · nullableOptional

descriptionstring · nullableOptional

fromQuantitynumber · double · nullableOptional

toQuantitynumber · double · nullableOptional

priceBasestring · enumOptionalPossible values:

lineDiscountPercentnumber · double · nullableOptional

lineDiscountAmountnumber · double · nullableOptional

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

404

Not Found

application/problem+json

500

Internal Server Error

application/problem+json

get/subscription-product-charges/{id}/details

GET /subscription-product-charges/{id}/details HTTP/1.1
Accept: */*

[
  {
    "tier": 1,
    "price": 1,
    "listPrice": 1,
    "description": "text",
    "fromQuantity": 1,
    "toQuantity": 1,
    "priceBase": "Flat",
    "lineDiscountPercent": 1,
    "lineDiscountAmount": 1
  }
]

---