Get a premium by its ID. | Virtuous Developer Documentation

{
  "id": 1,
  "currency": "USD",
  "name": "Charity T-Shirt",
  "nameShort": "T-Shirt",
  "code": "TSHIRT2024",
  "description": "A high-quality cotton t-shirt supporting our cause.",
  "isActive": true,
  "price": 25.99,
  "formattedPrice": "$25.99",
  "fairMarketValue": 15,
  "formattedFairMarketValue": "$15.00",
  "inventory": 150,
  "keepActiveWhenHasNoInventory": false,
  "recurringPremiumId": 10,
  "recurringPremiumName": "Monthly Donor Package",
  "image": "https://cdn.raisedonors.com/premiums/tshirt2024.png",
  "externalIdentifier": "EXT-TSHIRT-2024",
  "otherMinimumAmounts": [
    {
      "currency": "USD",
      "value": 10
    },
    {
      "currency": "USD",
      "value": 50
    }
  ]
}

Authentication

Authorizationstring

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

Path parameters

idlongRequired

The ID of the premium.

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

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.

recurringPremiumNamestring or nullOptional

Gets or sets the recurringpremium name.

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.

Errors

404

Not Found Error