GET
/
v1
/
priceagreement
/
period
/
{id}
{
  "lowest": false,
  "priceListId": "<string>",
  "code": "<string>",
  "type": "PER_EACH",
  "validFrom": "2022-05-12T13:18:05Z",
  "validTo": "2022-05-12T13:18:05Z",
  "value": 123,
  "id": "<string>",
  "priceAgreementId": "<string>"
}

Path Parameters

​
id
string
required

The id of the price agreement period you want to fetch

Query Parameters

​
auditUser
string
required

The audit user to log the request

Response

Successfully retrieved

​
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.

​
priceListId
string

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

Maximum length: 64
​
code
string

Product code for this agreement period

Maximum length: 64
​
type
enum<string>

Tells which kind of discount calculation that applies

Available options:
PER_EACH,
ABSOLUTE,
PERCENT
​
validFrom
string<date-time>

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

Example:

"2022-05-12T13:18:05Z"

​
validTo
string<date-time>

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

Example:

"2022-05-12T13:18:05Z"

​
value
number

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

​
id
string

The id of a price agreement period

Maximum length: 64
​
priceAgreementId
string

The primary key of the price agreement

Maximum length: 64