GET
/
v1
/
priceagreement
/
{id}
/
period

Path Parameters

​
id
string
required

The id of the price agreement to which periods should be fetched

Query Parameters

​
auditUser
string
required

The audit user to log the request

​
page
integer
default:
0

Current page

​
size
integer
default:
30

How many agreement periods should be returned per page, default is 30. Cannot be more than 100.

Required range: 1 <= x <= 100

Response

200 - application/json
​
code
string

Product code for this agreement period

Maximum length: 64
​
id
string

The id of a price agreement period

Maximum length: 64
​
lowest
boolean
default:
false

After all logic and repricing, should the lowest price apply. I.E the repriced one or the one coming from the merchant.

​
priceAgreementId
string

The primary key of the price agreement

Maximum length: 64
​
priceListId
string

A reference to a price list, using the id of the price list

Maximum length: 64
​
type
enum<string>

Tells which kind of discount calculation that applies

Available options:
PER_EACH,
ABSOLUTE,
PERCENT
​
validFrom
string

The RFC 3339 format date and time from what time the price list should be active. Cannot be null

​
validTo
string

The RFC 3339 format date and time when this price list should stop to be active. Cannot be greater than 'validFrom' of any other price list with the same 'code'. Can be null, which means this price list is active until this field is set

​
value
number

The value connected to the type field above. This can be 45.4 PER_EACH, 5.0 PERCENT etc.

Retrieves one price agreementRetrieves a price agreement period