Get localized course price

POST

public

get-course-price

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-course-price \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "data": {
        "fermionCourseId": "<string>",
        "fermionSchoolId": "<string>",
        "discountCouponCode": "<string>",
        "userCountryHint": "<string>"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "prices": [
          {
            "planType": "PartialPaymentPlan",
            "fermionDigitalProductPriceId": "<string>",
            "realFullPriceOfProductInLowestCurrencyUnitIrrespectiveOfTaxAndExclusiveOfDiscount": 123,
            "totalDiscountComponentValueInLowestCurrencyUnit": 123,
            "basePaymentToPayExclusiveOfTaxAndIrrespectiveOfDiscountInLowestCurrencyUnit": 1,
            "emiIntervalInDays": 90,
            "allInstallmentOptions": [
              {
                "eachInstallmentPaymentAmountInLowestCurrencyUnitExclusiveOfTaxAndDiscount": 123,
                "eachInstallmentPaymentAmountInLowestCurrencyUnitInclusiveOfDiscountButExclusiveOfTax": 123,
                "installmentCount": 2,
                "installmentPaymentScheduleInformation": [
                  {
                    "payByDate": "2023-11-07T05:31:56Z"
                  }
                ]
              }
            ],
            "currencySymbol": "<string>",
            "currencyType": "Aud",
            "inrGstSpecificData": {
              "isAmountExclusiveOfGst": true,
              "additionalGstAmountInrPaise": 123
            },
            "couponData": {
              "status": "ok",
              "discountCodeUsed": "<string>",
              "couponTypeSpecificData": {
                "type": "percent-off",
                "discountPercentOffApplied": 123
              },
              "description": "<string>"
            }
          }
        ]
      }
    }
  }
]

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.fermionCourseId

string

required

Course ID of the course. You can find IDs of your course using get-all-courses API endpoint

data.data.fermionSchoolId

string

required

Your school ID

data.data.discountCouponCode

string · null · null

required

Any discount code you want to apply to get updated prices. Send null if no discount code should be applied

data.data.userCountryHint

string | null

Two letter country code of user to force apply regional pricing. If not provided then we will use the country code of the user making this request.

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.prices

object[]

required

Array of available pricing plans for the course. Each plan includes payment options, currency information, applicable discounts, and tax details

Option 1
Option 2

Show child attributes

output.data.prices.planType

enum<string>

required

Available options:

PartialPaymentPlan

output.data.prices.fermionDigitalProductPriceId

string

required

output.data.prices.realFullPriceOfProductInLowestCurrencyUnitIrrespectiveOfTaxAndExclusiveOfDiscount

number

required

output.data.prices.totalDiscountComponentValueInLowestCurrencyUnit

number

required

output.data.prices.basePaymentToPayExclusiveOfTaxAndIrrespectiveOfDiscountInLowestCurrencyUnit

number

required

Required range: x >= 0

output.data.prices.emiIntervalInDays

number

required

Required range: 0 <= x <= 180

output.data.prices.allInstallmentOptions

object[]

required

Minimum array length: 1

Show child attributes

output.data.prices.allInstallmentOptions.eachInstallmentPaymentAmountInLowestCurrencyUnitExclusiveOfTaxAndDiscount

number

required

output.data.prices.allInstallmentOptions.eachInstallmentPaymentAmountInLowestCurrencyUnitInclusiveOfDiscountButExclusiveOfTax

number

required

output.data.prices.allInstallmentOptions.installmentCount

number

required

Required range: x >= 1

output.data.prices.allInstallmentOptions.installmentPaymentScheduleInformation

object[]

required

Show child attributes

output.data.prices.allInstallmentOptions.installmentPaymentScheduleInformation.payByDate

string<date-time>

required

output.data.prices.currencySymbol

string

required

output.data.prices.currencyType

enum<string>

required

Available options:

Aud,

Bdt,

Brl,

Cad,

Cop,

Dop,

Etb,

Eur,

Gbp,

Idr,

Inr,

Kes,

Lkr,

Mad,

Myr,

Mxn,

Ngn,

Npr,

Nzd,

Pkr,

Pln,

Rub,

Thb,

Try,

Usd,

Sgd,

Cny,

Sar,

Twd,

Jpy,

Krw,

Vnd

output.data.prices.inrGstSpecificData

object

required

Option 1
Option 2

Show child attributes

output.data.prices.inrGstSpecificData.isAmountExclusiveOfGst

enum<boolean>

required

Available options:

true,

false

output.data.prices.inrGstSpecificData.additionalGstAmountInrPaise

number

required

output.data.prices.couponData

object

required

Option 1
Option 2

Show child attributes

output.data.prices.couponData.status

enum<string>

required

Available options:

ok

output.data.prices.couponData.discountCodeUsed

string

required

output.data.prices.couponData.couponTypeSpecificData

object

required

Option 1
Option 2

Show child attributes

output.data.prices.couponData.couponTypeSpecificData.type

enum<string>

required

Available options:

percent-off

output.data.prices.couponData.couponTypeSpecificData.discountPercentOffApplied

number

required

output.data.prices.couponData.description

string

required

List course items Get published course items for an individual course Rate limit: Maximum 15 requests in a window of 1m.

⌘I

Get localized course price

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-course-price \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "data": {
        "fermionCourseId": "<string>",
        "fermionSchoolId": "<string>",
        "discountCouponCode": "<string>",
        "userCountryHint": "<string>"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "prices": [
          {
            "planType": "PartialPaymentPlan",
            "fermionDigitalProductPriceId": "<string>",
            "realFullPriceOfProductInLowestCurrencyUnitIrrespectiveOfTaxAndExclusiveOfDiscount": 123,
            "totalDiscountComponentValueInLowestCurrencyUnit": 123,
            "basePaymentToPayExclusiveOfTaxAndIrrespectiveOfDiscountInLowestCurrencyUnit": 1,
            "emiIntervalInDays": 90,
            "allInstallmentOptions": [
              {
                "eachInstallmentPaymentAmountInLowestCurrencyUnitExclusiveOfTaxAndDiscount": 123,
                "eachInstallmentPaymentAmountInLowestCurrencyUnitInclusiveOfDiscountButExclusiveOfTax": 123,
                "installmentCount": 2,
                "installmentPaymentScheduleInformation": [
                  {
                    "payByDate": "2023-11-07T05:31:56Z"
                  }
                ]
              }
            ],
            "currencySymbol": "<string>",
            "currencyType": "Aud",
            "inrGstSpecificData": {
              "isAmountExclusiveOfGst": true,
              "additionalGstAmountInrPaise": 123
            },
            "couponData": {
              "status": "ok",
              "discountCodeUsed": "<string>",
              "couponTypeSpecificData": {
                "type": "percent-off",
                "discountPercentOffApplied": 123
              },
              "description": "<string>"
            }
          }
        ]
      }
    }
  }
]

Using API

Endpoints

Body

Response