Skip to main content
POST
Create a Premium
Send its name, code, price, and fairMarketValue, set inventory and keepActiveWhenHasNoInventory to control availability, and use otherMinimumAmounts to set the gift amounts that qualify. Returns the created premium with its new id, which you can pass as premiumId when processing a donation.

Authorizations

Authorization
string
header
required

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

Body

The premium request model.

Represents a premium request.

name
string
required

The name of the premium.

Required string length: 1 - 255
code
string
required

The code that identifies the premium.

Required string length: 1 - 100
nameShort
string | null

The short name of the premium, used where space is limited.

Maximum string length: 150
description
string | null

The description of the premium.

price
number<double>

The amount a donor must give to receive the premium.

Required range: 0 <= x <= 1000000000000
fairMarketValue
number<double>

The fair market value of the premium, used for tax receipting.

Required range: 0 <= x <= 1000000000000
digitalUrl
string | null

The URL a digital premium is delivered from.

isActive
boolean

Whether the premium is active.

isFree
boolean

Whether the premium is offered at no minimum gift amount.

inventory
integer<int32> | null

The number of units of the premium left in stock.

keepActiveWhenHasNoInventory
boolean

Whether the premium stays active when it has no inventory.

recurringPremiumId
integer<int64> | null

The unique identifier of the premium to send for recurring gifts instead.

projectId
integer<int64> | null

The unique identifier of the project the cost of the premium is charged to.

image
string | null

The URL of the image shown for the premium.

externalIdentifier
string | null

An identifier of your own to store on the premium, for reconciling it with an external system.

otherMinimumAmounts
object[] | null

The minimum gift amounts that qualify for the premium in other currencies.

Response

OK

Represents a premium model.

id
integer<int64>

The unique identifier of the premium.

currency
string | null

The three-letter ISO currency code of the price and fair market value.

name
string | null

The name of the premium.

nameShort
string | null

The short name of the premium, used where space is limited.

code
string | null

The code of the premium.

description
string | null

The description of the premium.

isActive
boolean

Whether the premium is active.

price
number<double>

The amount a donor must give to receive the premium.

formattedPrice
string | null
read-only

The price, formatted for display in its currency.

fairMarketValue
number<double> | null

The fair market value of the premium, used for tax receipting.

formattedFairMarketValue
string | null
read-only

The fair market value, formatted for display in its currency.

inventory
integer<int32> | null

The number of units of the premium left in stock.

keepActiveWhenHasNoInventory
boolean

Whether the premium stays active when it has no inventory.

recurringPremiumId
integer<int64> | null

The unique identifier of the premium sent for recurring gifts instead.

recurringPremiumName
string | null

The name of the premium sent for recurring gifts instead.

image
string | null

The URL of the image shown for the premium.

externalIdentifier
string | null

An identifier of your own to store on the premium, for reconciling it with an external system.

otherMinimumAmounts
object[] | null

The minimum gift amounts that qualify for the premium in other currencies.

Last modified on July 28, 2026