Create a new premium.

POST

https://prod-api.raisedonors.com/api/Premium

POST

/api/Premium

curl -X POST https://prod-api.raisedonors.com/api/Premium \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Eco-Friendly Water Bottle",
  "code": "ECO-WB-2024"
}'

{
  "id": 1024,
  "currency": "USD",
  "name": "Eco-Friendly Water Bottle",
  "nameShort": "Eco Bottle",
  "code": "ECO-WB-2024",
  "description": "A reusable water bottle made from sustainable materials, perfect for everyday use.",
  "isActive": true,
  "price": 25.99,
  "formattedPrice": "$25.99",
  "fairMarketValue": 30,
  "formattedFairMarketValue": "$30.00",
  "inventory": 150,
  "keepActiveWhenHasNoInventory": false,
  "recurringPremiumId": 2001,
  "recurringPremiumName": "Monthly Eco Kit",
  "image": "https://cdn.raisedonors.com/images/premiums/eco-bottle.png",
  "externalIdentifier": "SKU-EB-2024",
  "otherMinimumAmounts": [
    {
      "currency": "EUR",
      "value": 23.5
    }
  ]
}

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Request

The premium request model.

namestringRequired1-255 characters

codestringRequired1-100 characters

nameShortstring or nullOptional<=150 characters

descriptionstring or nullOptional

Gets or sets the description.

pricedoubleOptional0-1000000000000

fairMarketValuedoubleOptional0-1000000000000

digitalUrlstring or nullOptional

Gets or sets the digital URL.

isActivebooleanOptional

Gets or sets a value indicating whether active.

isFreebooleanOptional

Gets or sets a value indicating whether free.

inventoryinteger or nullOptional

Gets or sets the inventory.

keepActiveWhenHasNoInventorybooleanOptional

Gets or sets the keep active when has no inventory.

recurringPremiumIdlong or nullOptional

Gets or sets the recurringpremium identifier.

projectIdlong or nullOptional

Gets or sets the project identifier.

imagestring or nullOptional

Gets or sets the image.

externalIdentifierstring or nullOptional

Gets or sets the external identifier.

otherMinimumAmountslist of objects or nullOptional

Gets or sets the other minimum amounts.

Response

idlongOptional

Gets or sets the identifier.

currencystring or nullOptional

Gets or sets the currency.

namestring or nullOptional

Gets or sets the name.

nameShortstring or nullOptional

Gets or sets the name short.

codestring or nullOptional

Gets or sets the code.

descriptionstring or nullOptional

Gets or sets the description.

isActivebooleanOptional

Gets or sets a value indicating whether active.

pricedoubleOptional

Gets or sets the price.

formattedPricestring or nullOptionalRead-only

fairMarketValuedouble or nullOptional

Gets or sets the fair market value.

formattedFairMarketValuestring or nullOptionalRead-only