PUT v1/SubscriptionProductsCalculator

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Put.SubscriptionProduct

Name	Type	Additional information
planProductId	integer	None.
quantity	decimal number	Range: inclusive between 0 and 2147483647
isIncluded	boolean	None.
startDate	date	None.
subscriptionProductOverride	Common.Dto.Put.SubscriptionProductOverride	None.
subscriptionProductPriceOverride	Common.Dto.Put.SubscriptionProductPriceOverride	None.
chargeAtSubscriptionActivation	boolean	None.
subscriptionProductDiscount	Common.Dto.Put.SubscriptionProductDiscount	None.
subscriptionProductDiscounts	Collection of Common.Dto.Put.SubscriptionProductDiscount	None.
quantityChangeDescription	string	String length: inclusive between 0 and 1000
earningSettings	Common.Dto.Put.SubscriptionProductEarningTiming	None.
remainingInterval	integer	Range: inclusive between 0 and 9.22337203685478E+18
intervalsUntilStart	integer	Range: inclusive between 0 and 9.22337203685478E+18
upliftPriorToRecharge	boolean	None.
includingInitialCharge	boolean	None.
priceUpliftsEnabled	boolean	None.
priceUplifts	Collection of Common.Dto.Put.SubscriptionProductPriceUplift	None.
customServiceDateNumberOfIntervals	integer	Range: inclusive between 0 and 99
customServiceDateInterval	string	None.
customServiceDateProjection	string	None.
generateZeroDollarCharge	boolean	None.
id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "planProductId": 1,
  "quantity": 2.0,
  "isIncluded": true,
  "startDate": "2025-05-21T08:06:17.9030035+00:00",
  "subscriptionProductOverride": {
    "name": "sample string 1",
    "description": "sample string 2",
    "id": 3
  },
  "subscriptionProductPriceOverride": {
    "chargeAmount": 1.0,
    "priceRanges": [
      {
        "min": 1.0,
        "max": 1.0,
        "price": 2.0
      },
      {
        "min": 1.0,
        "max": 1.0,
        "price": 2.0
      }
    ],
    "pricingModelType": "sample string 1",
    "id": 2
  },
  "chargeAtSubscriptionActivation": true,
  "subscriptionProductDiscount": {
    "discountType": "sample string 1",
    "amount": 2.0,
    "remainingUsagesUntilStart": 3,
    "remainingUsage": 1,
    "id": 4
  },
  "subscriptionProductDiscounts": [
    {
      "discountType": "sample string 1",
      "amount": 2.0,
      "remainingUsagesUntilStart": 3,
      "remainingUsage": 1,
      "id": 4
    },
    {
      "discountType": "sample string 1",
      "amount": 2.0,
      "remainingUsagesUntilStart": 3,
      "remainingUsage": 1,
      "id": 4
    }
  ],
  "quantityChangeDescription": "sample string 5",
  "earningSettings": {
    "earningTimingInterval": "sample string 1",
    "earningTimingType": "sample string 2",
    "earningInterval": 1,
    "earningNumberOfInterval": 1
  },
  "remainingInterval": 1,
  "intervalsUntilStart": 1,
  "upliftPriorToRecharge": true,
  "includingInitialCharge": true,
  "priceUpliftsEnabled": true,
  "priceUplifts": [
    {
      "sequenceNumber": 1,
      "remainingIntervals": 2,
      "amount": 3.0,
      "repeatForever": true,
      "upliftType": "sample string 5",
      "upliftPriorToRecharge": true
    },
    {
      "sequenceNumber": 1,
      "remainingIntervals": 2,
      "amount": 3.0,
      "repeatForever": true,
      "upliftType": "sample string 5",
      "upliftPriorToRecharge": true
    }
  ],
  "customServiceDateNumberOfIntervals": 9,
  "customServiceDateInterval": "sample string 10",
  "customServiceDateProjection": "sample string 11",
  "generateZeroDollarCharge": true,
  "id": 13
}

Response Information

Resource Description

Collection of Common.Dto.Get.DraftCharge

Name	Type	Additional information
transactionId	integer	None.
chargeTypeId	string	None.
transactionType	string	None.
quantity	decimal number	None.
unitPrice	decimal number	None.
amount	decimal number	None.
taxableAmount	decimal number	None.
subscriptionPeriodId	integer	None.
draftInvoiceId	integer	None.
name	string	None.
description	string	None.
effectiveTimestamp	date	None.
proratedUnitPrice	decimal number	None.
startServiceDate	date	None.
endServiceDate	date	None.
rangeQuantity	decimal number	None.
draftDiscount	Common.Dto.Get.DraftDiscount	None.
draftDiscounts	Collection of Common.Dto.Get.DraftDiscount	None.
status	string	None.
productItems	Collection of Common.Dto.Get.ProductItem	None.
canProrateCharge	boolean	None.
postable	boolean	None.
subscriptionProductId	integer	None.
purchaseId	integer	None.
productId	integer	None.
draftChargeTiers	Collection of Common.Dto.Get.DraftChargeTier	None.
hasPurchasePerformanceObligations	boolean	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "transactionId": 1,
    "chargeTypeId": "sample string 2",
    "transactionType": "sample string 3",
    "quantity": 4.0,
    "unitPrice": 5.0,
    "amount": 6.0,
    "taxableAmount": 7.0,
    "subscriptionPeriodId": 8,
    "draftInvoiceId": 9,
    "name": "sample string 10",
    "description": "sample string 11",
    "effectiveTimestamp": "2025-05-21T08:06:17.91913+00:00",
    "proratedUnitPrice": 1.0,
    "startServiceDate": "2025-05-21T08:06:17.91913+00:00",
    "endServiceDate": "2025-05-21T08:06:17.91913+00:00",
    "rangeQuantity": 1.0,
    "draftDiscount": {
      "draftChargeId": 1,
      "configuredDiscountAmount": 2.0,
      "amount": 3.0,
      "quantity": 4.0,
      "discountType": "sample string 5",
      "effectiveTimestamp": "2025-05-21T08:06:17.91913+00:00",
      "description": "sample string 7",
      "id": 8,
      "uri": "sample string 9"
    },
    "draftDiscounts": [
      {
        "draftChargeId": 1,
        "configuredDiscountAmount": 2.0,
        "amount": 3.0,
        "quantity": 4.0,
        "discountType": "sample string 5",
        "effectiveTimestamp": "2025-05-21T08:06:17.91913+00:00",
        "description": "sample string 7",
        "id": 8,
        "uri": "sample string 9"
      },
      {
        "draftChargeId": 1,
        "configuredDiscountAmount": 2.0,
        "amount": 3.0,
        "quantity": 4.0,
        "discountType": "sample string 5",
        "effectiveTimestamp": "2025-05-21T08:06:17.91913+00:00",
        "description": "sample string 7",
        "id": 8,
        "uri": "sample string 9"
      }
    ],
    "status": "sample string 15",
    "productItems": null,
    "canProrateCharge": true,
    "postable": true,
    "subscriptionProductId": 1,
    "purchaseId": 1,
    "productId": 1,
    "draftChargeTiers": [
      {
        "label": "sample string 1",
        "quantity": 2.0,
        "unitPrice": 3.0,
        "amount": 4.0,
        "sortOrder": 5
      },
      {
        "label": "sample string 1",
        "quantity": 2.0,
        "unitPrice": 3.0,
        "amount": 4.0,
        "sortOrder": 5
      }
    ],
    "hasPurchasePerformanceObligations": true,
    "id": 19,
    "uri": "sample string 20"
  },
  {
    "transactionId": 1,
    "chargeTypeId": "sample string 2",
    "transactionType": "sample string 3",
    "quantity": 4.0,
    "unitPrice": 5.0,
    "amount": 6.0,
    "taxableAmount": 7.0,
    "subscriptionPeriodId": 8,
    "draftInvoiceId": 9,
    "name": "sample string 10",
    "description": "sample string 11",
    "effectiveTimestamp": "2025-05-21T08:06:17.91913+00:00",
    "proratedUnitPrice": 1.0,
    "startServiceDate": "2025-05-21T08:06:17.91913+00:00",
    "endServiceDate": "2025-05-21T08:06:17.91913+00:00",
    "rangeQuantity": 1.0,
    "draftDiscount": {
      "draftChargeId": 1,
      "configuredDiscountAmount": 2.0,
      "amount": 3.0,
      "quantity": 4.0,
      "discountType": "sample string 5",
      "effectiveTimestamp": "2025-05-21T08:06:17.91913+00:00",
      "description": "sample string 7",
      "id": 8,
      "uri": "sample string 9"
    },
    "draftDiscounts": [
      {
        "draftChargeId": 1,
        "configuredDiscountAmount": 2.0,
        "amount": 3.0,
        "quantity": 4.0,
        "discountType": "sample string 5",
        "effectiveTimestamp": "2025-05-21T08:06:17.91913+00:00",
        "description": "sample string 7",
        "id": 8,
        "uri": "sample string 9"
      },
      {
        "draftChargeId": 1,
        "configuredDiscountAmount": 2.0,
        "amount": 3.0,
        "quantity": 4.0,
        "discountType": "sample string 5",
        "effectiveTimestamp": "2025-05-21T08:06:17.91913+00:00",
        "description": "sample string 7",
        "id": 8,
        "uri": "sample string 9"
      }
    ],
    "status": "sample string 15",
    "productItems": null,
    "canProrateCharge": true,
    "postable": true,
    "subscriptionProductId": 1,
    "purchaseId": 1,
    "productId": 1,
    "draftChargeTiers": [
      {
        "label": "sample string 1",
        "quantity": 2.0,
        "unitPrice": 3.0,
        "amount": 4.0,
        "sortOrder": 5
      },
      {
        "label": "sample string 1",
        "quantity": 2.0,
        "unitPrice": 3.0,
        "amount": 4.0,
        "sortOrder": 5
      }
    ],
    "hasPurchasePerformanceObligations": true,
    "id": 19,
    "uri": "sample string 20"
  }
]