Subscriptionproductcharges

get

Get metrics by subscription product charge id

Path parameters
idstring · uuidRequired
Header parameters
AuthorizationanyRequired
Legal-EntityanyRequired
Responses
200

OK

application/json
get
GET /subscription-product-charges/{id}/metrics HTTP/1.1
Host: 
Accept: */*

[
  {
    "baseCurrencyCode": "text",
    "currencyConversionDate": "2025-10-08T19:37:14.018Z",
    "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
get
GET /subscription-product-charges?subscriptionModifiedAfter=2025-10-08T19%3A37%3A14.018Z&subscriptionModifiedBefore=2025-10-08T19%3A37%3A14.018Z HTTP/1.1
Host: 
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created": "2025-10-08T19:37:14.018Z",
      "modified": "2025-10-08T19:37:14.018Z",
      "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": "2025-10-08",
      "effectiveEndDate": "2025-10-08",
      "quantity": 1,
      "startOn": "AlignToSubscription",
      "endOn": "AlignToSubscription",
      "invoicedToDate": "2025-10-08",
      "lastRenewalDate": "2025-10-08",
      "lastPriceAdjustmentDate": "2025-10-08",
      "pricePeriod": "Monthly",
      "usageRating": "Sum",
      "billingDay": "None",
      "specificBillingDay": 1,
      "billingPeriod": "Monthly",
      "billingTiming": "InAdvance",
      "periodAlignment": "None",
      "alignmentDate": "2025-10-08",
      "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
get
GET /subscription-product-charges/{id}/details HTTP/1.1
Host: 
Accept: */*

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

Last updated

Was this helpful?