Product

productId

integer (as string)

Unique product ID

parentProductId

integer (as string)

ID of the parent product, if any

clientId

string

Your client ID

type

Product type

bundle

Bundle type

code

string

name

string

Product display name

description

string

A detailed description of the product

url

URL (string)

price

price

vat

integer (as string)

VAT, fraction × 10000. For instance, 25% would be 2500

currency

string

Price and VAT currency

paymentOptions

Payment options

Available payment options for this product

quantityLimit

integer (as string)

Maximum available sales for this product.

quantityCount

integer (as string)

Number of sales for this product so far

saleStart

datetime

Start of a sale for this product (i.e. reduced price or with additional benefits)

saleStop

datetime

End of a sale

availableStart

datetime

When this product is available for purchase

availableStop

datetime

When this product is no longer available for purchase

subscriptionPeriod

timestamp, in seconds

The subscription period

subscriptionRenewPrice

price

Price of subscription renewal

subscriptionRenewPeriod

timestamp, in seconds

For how long a renewal is valid

subscriptionAutoRenew

string, "1" (true) or "0" (false)

If "1", the subscription automatically renews

subscriptionAutoRenewLockPeriod

timestamp, in seconds

The initial period during which auto renew cannot be changed

subscriptionAutoRenewDisabled

string, "1" (true) or "0" (false)

If "1", auto renew is not available

subscriptionGracePeriod

integer (as string)

The period after a failed renewal charge the subscription will stay active

subscriptionEmailReceiptLimit

integer (as string)

The maximum number of email receipts

subscriptionFinalEndDate

datetime

By this date, the subscription is no longer for sale

allowMultiSales

string, "1" (true) or "0" (false)

If "1", users can purchase this product multiple times

status

Product status

changedBy

integer (as string)

ID of the user that made the last change

changed

datetime

createdBy

integer (as string)

ID of the user that created this product

created

datetime

purchaseUri

URL (string)

A URI where the product may be purchased

The check mark indicates that the field always contains a valid non-empty value.

Product status

An enum, with the following possible values:

"-1"

Deleted

"0"

Not available

"1"

Available, but not visible

"2"

Available, but not selectable

"3"

Available

Payment options

Payment options can be provided as a bit mask.

Bitmask format is the default format. If payment options are not provided, the default value is 2 (bank card with PayEx).

Examples: 2 means credit card, 4 means SMS, while 6 means both credit card and SMS.

An enum, with the following possible values:

"1"

Masterpass

"2"

Credit card

"4"

SMS

"8"

PayEx Invoice

"16"

Voucher

"32"

Klarna Invoice

"64"

Klarna Mobile

"128"

Wallet

Bundle type

An enum, with the following possible values:

"0"

Not a bundle

"1"

Dynamic bundle

"2"

Onetime bundle

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.