Coupon

Check coupon price - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

This API returns the price that is registered on a Coupon. It also returns the distribution cost ets. if parameters for country code and postal code are set.

SecurityClient_Credentials
Request
Request Body schema: application/json
couponCode
required
string <= 12 characters

Coupon code

couponNumber
required
integer

Coupon number

customerNumber
integer

Customer number

countryCode
string <= 3 characters

The country code - ISO 3166 - alpha-2.

postalCode
string <= 10 characters

Postal code for address

Responses
200

OK

Response Schema: application/json
companyCode
string <= 12 characters

Company code

product
string <= 12 characters

Product code

price
number decimal places <= 2

Price

vatAmount
number decimal places <= 2

Vat amount

vatpercent
number decimal places <= 2

Vat percentage

vatInclude
boolean

Informs if vat is included or not

  • true: Vat is included in price
  • false: Vat is not included
currency
string <= 3 characters

Currency standard - ISO4217 - alphabetic code.

distAmount
number decimal places <= 2

Amount for distribution price

distAmountvat
number decimal places <= 2

Vat amount on dist amount.

customerNumber
integer

Customer Number

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/client/coupon/price
Request samples
application/json
{
  • "couponCode": "TOTT",
  • "couponNumber": 60,
  • "customerNumber": 10,
  • "countryCode": "NO",
  • "postalCode": "1273"
}
Response samples
application/json
{
  • "companyCode": "FTOTT",
  • "product": "TOTT",
  • "price": 100,
  • "vatAmount": 25,
  • "vatpercent": 25,
  • "vatInclude": false,
  • "currency": "NOK",
  • "distAmount": 0,
  • "distAmountvat": 0,
  • "customerNumber": 10
}

List coupon - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

This API returns all coupons for a subscription product. You may also use this API to check the price at the next renewal.

SecurityClient_Credentials
Request
path Parameters
productCode
required
string <= 12 characters

Product code

Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/client/coupon/{productCode}
Request samples
Response samples
application/json
{
  • "coupons": [
    ]
}