Skip to main content
POST
Create a product price

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new ProductPrice resource

currency
string | null
product
string<iri-reference>
Example:

"/api/v1/products/1"

price
number | null
name
string | null
isArchived
boolean | null
isSubscription
boolean | null
isRestricted
string | null
allowedFeeProductPrices
array
isDefault
boolean | null
fullDescription
string | null
displayNameOnPaymentPage
boolean | null
overwriteMonthPeriod
integer | null
isLifetime
boolean | null
isHidden
boolean | null
productPriceVariationValues
string<iri-reference>[]
Example:
isBundle
boolean | null
validFrom
string<date-time> | null
validTo
string<date-time> | null
ageUnder
integer | null
ageOver
integer | null
previousVersion
unknown
companySlots
integer | null
isCompanyPrice
boolean
default:false
maxSeats
integer | null
sortOrder
integer | null
groupName
string | null

Response

ProductPrice resource created

id
integer
read-only
currency
string | null
product
object
price
number | null
name
string | null
isArchived
boolean | null
isSubscription
boolean | null
isRestricted
string | null
allowedFeeProductPrices
array
isDefault
boolean | null
fullDescription
string | null
displayNameOnPaymentPage
boolean | null
overwriteMonthPeriod
integer | null
isLifetime
boolean | null
isHidden
boolean | null
productPriceVariationValues
string<iri-reference>[]
Example:
isBundle
boolean | null
isBundleMember
boolean | null
validFrom
string<date-time> | null
validTo
string<date-time> | null
ageUnder
integer | null
ageOver
integer | null
previousVersion
unknown
companySlots
integer | null
isCompanyPrice
boolean
default:false
maxSeats
integer | null
soldCount
integer
default:0
sortOrder
integer | null
groupName
string | null
addons
object[]
monthPeriod
integer | null
read-only
availableSeats
integer | null
read-only
activeAddons
object