Authorizations
Body
application/json
API Request Body
Response
200 - application/json
API Response Body
- Option 1
- Option 2
Create a new pricing plan (one-time payment or partial payment) for a digital product using the product slug. The plan will be created in draft status.
Authentication with the “FERMION-API-KEY” header is required to use this endpoint.
Rate limit: Maximum 60 requests in a window of 1m.
curl --request POST \
--url https://backend.codedamn.com/api/public/create-digital-product-pricing-plan \
--header 'Content-Type: application/json' \
--header 'FERMION-API-KEY: <api-key>' \
--data '{
"data": [
{
"data": {
"fermionDigitalProductSlug": "<string>",
"newPlanData": {
"fermionDigitalProductPriceId": "<string>",
"fermionDigitalProductId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"planStatus": "Published",
"planType": "OneTimePaymentPlan",
"config": {
"friendlyPlanName": "<string>",
"prices": [
{
"currencyType": "Aud",
"currencySymbol": "<string>",
"priceInLowestCurrencyUnit": 1
}
],
"inrCurrencySpecificData": {
"isAmountExclusiveOfGst": true
},
"defaultFallbackCurrency": "Aud",
"additionalDataToCollectOnCheckout": {
"customFields": [
{
"fieldType": "string",
"label": "<string>",
"sublabel": "<string>",
"isRequired": false
}
]
}
}
}
}
}
]
}'[
{
"output": {
"status": "ok",
"data": {
"newPricingPlan": {
"fermionDigitalProductPriceId": "<string>",
"fermionDigitalProductId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"planStatus": "Published",
"planType": "OneTimePaymentPlan",
"config": {
"friendlyPlanName": "<string>",
"prices": [
{
"currencyType": "Aud",
"currencySymbol": "<string>",
"priceInLowestCurrencyUnit": 1
}
],
"inrCurrencySpecificData": {
"isAmountExclusiveOfGst": true
},
"defaultFallbackCurrency": "Aud",
"additionalDataToCollectOnCheckout": {
"customFields": [
{}
]
}
}
}
}
}
}
]API Request Body
Show child attributes
API Response Body
Show child attributes
curl --request POST \
--url https://backend.codedamn.com/api/public/create-digital-product-pricing-plan \
--header 'Content-Type: application/json' \
--header 'FERMION-API-KEY: <api-key>' \
--data '{
"data": [
{
"data": {
"fermionDigitalProductSlug": "<string>",
"newPlanData": {
"fermionDigitalProductPriceId": "<string>",
"fermionDigitalProductId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"planStatus": "Published",
"planType": "OneTimePaymentPlan",
"config": {
"friendlyPlanName": "<string>",
"prices": [
{
"currencyType": "Aud",
"currencySymbol": "<string>",
"priceInLowestCurrencyUnit": 1
}
],
"inrCurrencySpecificData": {
"isAmountExclusiveOfGst": true
},
"defaultFallbackCurrency": "Aud",
"additionalDataToCollectOnCheckout": {
"customFields": [
{
"fieldType": "string",
"label": "<string>",
"sublabel": "<string>",
"isRequired": false
}
]
}
}
}
}
}
]
}'[
{
"output": {
"status": "ok",
"data": {
"newPricingPlan": {
"fermionDigitalProductPriceId": "<string>",
"fermionDigitalProductId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"planStatus": "Published",
"planType": "OneTimePaymentPlan",
"config": {
"friendlyPlanName": "<string>",
"prices": [
{
"currencyType": "Aud",
"currencySymbol": "<string>",
"priceInLowestCurrencyUnit": 1
}
],
"inrCurrencySpecificData": {
"isAmountExclusiveOfGst": true
},
"defaultFallbackCurrency": "Aud",
"additionalDataToCollectOnCheckout": {
"customFields": [
{}
]
}
}
}
}
}
}
]