@epilot/pricing-client 3.48.0-alpha.0 → 3.48.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +37 -4
- package/dist/openapi.d.ts +940 -889
- package/dist/openapi.json +944 -268
- package/package.json +3 -2
package/dist/openapi.json
CHANGED
|
@@ -159,6 +159,14 @@
|
|
|
159
159
|
"price_id": "396cb5f3-ea0b-4629-99ca-303661de5a9b",
|
|
160
160
|
"quantity": 2
|
|
161
161
|
},
|
|
162
|
+
{
|
|
163
|
+
"product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
|
|
164
|
+
"price_id": "396cb5f3-ea0b-4629-99ca-303661de5a9b",
|
|
165
|
+
"quantity": 2,
|
|
166
|
+
"coupon_ids": [
|
|
167
|
+
"0f8c4852-23fa-4a64-a2f3-88702335f094"
|
|
168
|
+
]
|
|
169
|
+
},
|
|
162
170
|
{
|
|
163
171
|
"product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
|
|
164
172
|
"price_id": "2abe0c6f-63ef-417b-8c85-5546359382d9",
|
|
@@ -175,6 +183,263 @@
|
|
|
175
183
|
}
|
|
176
184
|
}
|
|
177
185
|
]
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
|
|
189
|
+
"price_id": "b59acf37-3cc0-456c-a712-1db0fc478d2d",
|
|
190
|
+
"quantity": 1,
|
|
191
|
+
"price_component_coupon_ids": {
|
|
192
|
+
"583fb57a-7549-4624-82d6-342d5e6542f7": [
|
|
193
|
+
"0f8c4852-23fa-4a64-a2f3-88702335f094"
|
|
194
|
+
]
|
|
195
|
+
},
|
|
196
|
+
"price_mappings": [
|
|
197
|
+
{
|
|
198
|
+
"price_id": "25c7dc77-ac80-480a-92c0-8c0e913b5534",
|
|
199
|
+
"frequency_unit": "yearly",
|
|
200
|
+
"value": 10000,
|
|
201
|
+
"name": "Estimated consumption",
|
|
202
|
+
"metadata": {
|
|
203
|
+
"journey_title": "P&G",
|
|
204
|
+
"step_name": "Number Inputs"
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
],
|
|
208
|
+
"item_components": [
|
|
209
|
+
{
|
|
210
|
+
"pricing_model": "per_unit",
|
|
211
|
+
"quantity": 1,
|
|
212
|
+
"type": "recurring",
|
|
213
|
+
"billing_period": "monthly",
|
|
214
|
+
"price_id": "583fb57a-7549-4624-82d6-342d5e6542f7",
|
|
215
|
+
"product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
|
|
216
|
+
"_price": {
|
|
217
|
+
"pricing_model": "per_unit",
|
|
218
|
+
"unit_amount": 1500,
|
|
219
|
+
"unit_amount_currency": "EUR",
|
|
220
|
+
"unit_amount_decimal": "15",
|
|
221
|
+
"sales_tax": "standard",
|
|
222
|
+
"active": true,
|
|
223
|
+
"price_display_in_journeys": "show_price",
|
|
224
|
+
"type": "recurring",
|
|
225
|
+
"_title": "Base Price",
|
|
226
|
+
"tax": [
|
|
227
|
+
{
|
|
228
|
+
"_schema": "tax",
|
|
229
|
+
"active": true,
|
|
230
|
+
"description": "GST",
|
|
231
|
+
"rate": 19,
|
|
232
|
+
"region": "DE",
|
|
233
|
+
"type": "Custom",
|
|
234
|
+
"_id": "d792070e-328d-4d2c-8aba-5ac7b23ff621",
|
|
235
|
+
"_org": "739224",
|
|
236
|
+
"_created_at": "2024-12-18T14:14:53.340Z",
|
|
237
|
+
"_updated_at": "2025-02-11T11:07:49.660Z",
|
|
238
|
+
"_title": "GST",
|
|
239
|
+
"behavior": "inclusive"
|
|
240
|
+
}
|
|
241
|
+
],
|
|
242
|
+
"tax_behavior": "inclusive",
|
|
243
|
+
"billing_period": "monthly",
|
|
244
|
+
"billing_duration_unit": "months",
|
|
245
|
+
"notice_time_unit": "months",
|
|
246
|
+
"termination_time_unit": "months",
|
|
247
|
+
"renewal_duration_unit": "months",
|
|
248
|
+
"description": "Base Price",
|
|
249
|
+
"is_tax_inclusive": false,
|
|
250
|
+
"internal_description": "Base Price",
|
|
251
|
+
"variable_price": true
|
|
252
|
+
},
|
|
253
|
+
"taxes": [
|
|
254
|
+
{
|
|
255
|
+
"tax": {
|
|
256
|
+
"_schema": "tax",
|
|
257
|
+
"active": true,
|
|
258
|
+
"description": "GST",
|
|
259
|
+
"rate": 19,
|
|
260
|
+
"region": "DE",
|
|
261
|
+
"type": "Custom",
|
|
262
|
+
"_id": "d792070e-328d-4d2c-8aba-5ac7b23ff621",
|
|
263
|
+
"_org": "739224",
|
|
264
|
+
"_created_at": "2024-12-18T14:14:53.340Z",
|
|
265
|
+
"_updated_at": "2025-02-11T11:07:49.660Z",
|
|
266
|
+
"_title": "GST",
|
|
267
|
+
"behavior": "inclusive"
|
|
268
|
+
},
|
|
269
|
+
"amount": 285
|
|
270
|
+
}
|
|
271
|
+
],
|
|
272
|
+
"unit_amount": 1000,
|
|
273
|
+
"unit_amount_decimal": "10",
|
|
274
|
+
"currency": "EUR",
|
|
275
|
+
"description": "Base Price",
|
|
276
|
+
"is_tax_inclusive": false
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"pricing_model": "per_unit",
|
|
280
|
+
"quantity": 1,
|
|
281
|
+
"type": "recurring",
|
|
282
|
+
"billing_period": "monthly",
|
|
283
|
+
"price_id": "25c7dc77-ac80-480a-92c0-8c0e913b5534",
|
|
284
|
+
"product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
|
|
285
|
+
"_price": {
|
|
286
|
+
"_id": "25c7dc77-ac80-480a-92c0-8c0e913b5534",
|
|
287
|
+
"active": true,
|
|
288
|
+
"description": "Work Price",
|
|
289
|
+
"is_tax_inclusive": true,
|
|
290
|
+
"price_display_in_journeys": "show_price",
|
|
291
|
+
"pricing_model": "per_unit",
|
|
292
|
+
"type": "recurring",
|
|
293
|
+
"unit_amount": 10,
|
|
294
|
+
"unit_amount_currency": "EUR",
|
|
295
|
+
"unit_amount_decimal": "0.10",
|
|
296
|
+
"variable_price": true,
|
|
297
|
+
"billing_period": "monthly",
|
|
298
|
+
"internal_description": "Work Price",
|
|
299
|
+
"_title": "Work Price",
|
|
300
|
+
"unit": "kwh"
|
|
301
|
+
},
|
|
302
|
+
"taxes": [
|
|
303
|
+
{
|
|
304
|
+
"tax": {
|
|
305
|
+
"_schema": "tax",
|
|
306
|
+
"active": true,
|
|
307
|
+
"description": "19%",
|
|
308
|
+
"rate": 19,
|
|
309
|
+
"region": "DE",
|
|
310
|
+
"type": "VAT",
|
|
311
|
+
"_id": "bd488a36-cae5-4b18-9ca5-f5cbf6d9735b",
|
|
312
|
+
"_org": "739224",
|
|
313
|
+
"_created_at": "2025-01-15T12:04:52.431Z",
|
|
314
|
+
"_updated_at": "2025-01-15T12:04:52.431Z",
|
|
315
|
+
"_title": "19%"
|
|
316
|
+
},
|
|
317
|
+
"amount": 1331
|
|
318
|
+
}
|
|
319
|
+
],
|
|
320
|
+
"unit_amount": 8,
|
|
321
|
+
"unit_amount_decimal": "0.08",
|
|
322
|
+
"currency": "EUR",
|
|
323
|
+
"description": "Work Price",
|
|
324
|
+
"is_tax_inclusive": true
|
|
325
|
+
}
|
|
326
|
+
]
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"description": "Product Name",
|
|
330
|
+
"quantity": 1,
|
|
331
|
+
"is_composite_price": true,
|
|
332
|
+
"item_components": [
|
|
333
|
+
{
|
|
334
|
+
"quantity": 1,
|
|
335
|
+
"description": "Price Description",
|
|
336
|
+
"unit_amount": 10000,
|
|
337
|
+
"unit_amount_decimal": "100",
|
|
338
|
+
"unit_amount_currency": "EUR",
|
|
339
|
+
"pricing_model": "per_unit",
|
|
340
|
+
"taxes": [
|
|
341
|
+
{
|
|
342
|
+
"rate": "nontaxable",
|
|
343
|
+
"rateValue": 0,
|
|
344
|
+
"amount": 0
|
|
345
|
+
}
|
|
346
|
+
],
|
|
347
|
+
"type": "one_time",
|
|
348
|
+
"is_tax_inclusive": true
|
|
349
|
+
}
|
|
350
|
+
],
|
|
351
|
+
"currency": "EUR"
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"price_id": "b59acf37-3cc0-456c-a712-1db0fc478d2d",
|
|
355
|
+
"product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
|
|
356
|
+
"quantity": 1,
|
|
357
|
+
"description": "Power Test",
|
|
358
|
+
"is_composite_price": true,
|
|
359
|
+
"item_components": [
|
|
360
|
+
{
|
|
361
|
+
"price_id": "583fb57a-7549-4624-82d6-342d5e6542f7",
|
|
362
|
+
"product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
|
|
363
|
+
"quantity": 1,
|
|
364
|
+
"description": "Base Price",
|
|
365
|
+
"unit_amount": 1500,
|
|
366
|
+
"unit_amount_decimal": "15",
|
|
367
|
+
"unit_amount_currency": "EUR",
|
|
368
|
+
"pricing_model": "per_unit",
|
|
369
|
+
"type": "recurring",
|
|
370
|
+
"billing_period": "monthly",
|
|
371
|
+
"is_tax_inclusive": false,
|
|
372
|
+
"_coupons": [
|
|
373
|
+
{
|
|
374
|
+
"name": "My Custom Discount",
|
|
375
|
+
"type": "fixed",
|
|
376
|
+
"fixed_value": 500,
|
|
377
|
+
"fixed_value_currency": "EUR",
|
|
378
|
+
"fixed_value_decimal": "5",
|
|
379
|
+
"category": "discount",
|
|
380
|
+
"active": true,
|
|
381
|
+
"_schema": "coupon",
|
|
382
|
+
"requires_promo_code": false,
|
|
383
|
+
"_org": "739224",
|
|
384
|
+
"_created_at": "2025-02-24T10:01:24.537Z",
|
|
385
|
+
"_updated_at": "2025-02-24T10:01:24.537Z",
|
|
386
|
+
"percentage_value": "0",
|
|
387
|
+
"_title": "My Custom Discount"
|
|
388
|
+
}
|
|
389
|
+
]
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"price_id": "25c7dc77-ac80-480a-92c0-8c0e913b5534",
|
|
393
|
+
"product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
|
|
394
|
+
"quantity": 1,
|
|
395
|
+
"description": "Work Price",
|
|
396
|
+
"unit_amount": 10,
|
|
397
|
+
"unit_amount_decimal": "0.10123",
|
|
398
|
+
"unit_amount_currency": "EUR",
|
|
399
|
+
"pricing_model": "per_unit",
|
|
400
|
+
"taxes": [
|
|
401
|
+
{
|
|
402
|
+
"tax": {
|
|
403
|
+
"_schema": "tax",
|
|
404
|
+
"active": true,
|
|
405
|
+
"description": "19%",
|
|
406
|
+
"rate": 19,
|
|
407
|
+
"region": "DE",
|
|
408
|
+
"type": "VAT",
|
|
409
|
+
"_id": "bd488a36-cae5-4b18-9ca5-f5cbf6d9735b",
|
|
410
|
+
"_org": "739224",
|
|
411
|
+
"_created_at": "2025-01-15T12:04:52.431Z",
|
|
412
|
+
"_updated_at": "2025-01-15T12:04:52.431Z",
|
|
413
|
+
"_title": "19%"
|
|
414
|
+
},
|
|
415
|
+
"amount": 2
|
|
416
|
+
}
|
|
417
|
+
],
|
|
418
|
+
"type": "recurring",
|
|
419
|
+
"billing_period": "monthly",
|
|
420
|
+
"unit_amount_net": 8,
|
|
421
|
+
"unit_amount_gross": 10,
|
|
422
|
+
"amount_subtotal": 8,
|
|
423
|
+
"amount_total": 10,
|
|
424
|
+
"amount_tax": 2,
|
|
425
|
+
"is_tax_inclusive": true,
|
|
426
|
+
"unit_amount_net_decimal": "0.084033613445",
|
|
427
|
+
"unit_amount_gross_decimal": "0.1",
|
|
428
|
+
"amount_subtotal_decimal": "0.084033613445",
|
|
429
|
+
"amount_total_decimal": "0.1"
|
|
430
|
+
}
|
|
431
|
+
],
|
|
432
|
+
"price_mappings": [
|
|
433
|
+
{
|
|
434
|
+
"price_id": "583fb57a-7549-4624-82d6-342d5e6542f7",
|
|
435
|
+
"value": 1
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"price_id": "25c7dc77-ac80-480a-92c0-8c0e913b5534",
|
|
439
|
+
"value": 2000
|
|
440
|
+
}
|
|
441
|
+
],
|
|
442
|
+
"currency": "EUR"
|
|
178
443
|
}
|
|
179
444
|
]
|
|
180
445
|
}
|
|
@@ -1946,6 +2211,138 @@
|
|
|
1946
2211
|
}
|
|
1947
2212
|
}
|
|
1948
2213
|
}
|
|
2214
|
+
},
|
|
2215
|
+
"/v1/public/product-recommendations": {
|
|
2216
|
+
"post": {
|
|
2217
|
+
"description": "Get a list of product recommendations based on the search parameters.",
|
|
2218
|
+
"operationId": "$productRecommendations",
|
|
2219
|
+
"summary": "productRecommendations",
|
|
2220
|
+
"security": [
|
|
2221
|
+
{
|
|
2222
|
+
"EpilotPublicAuth": []
|
|
2223
|
+
}
|
|
2224
|
+
],
|
|
2225
|
+
"tags": [
|
|
2226
|
+
"Product Recommendations API"
|
|
2227
|
+
],
|
|
2228
|
+
"parameters": [
|
|
2229
|
+
{
|
|
2230
|
+
"in": "header",
|
|
2231
|
+
"name": "X-Ivy-Org-ID",
|
|
2232
|
+
"description": "The target Organization Id represented by the caller",
|
|
2233
|
+
"example": 739224,
|
|
2234
|
+
"schema": {
|
|
2235
|
+
"type": "string"
|
|
2236
|
+
}
|
|
2237
|
+
}
|
|
2238
|
+
],
|
|
2239
|
+
"requestBody": {
|
|
2240
|
+
"required": true,
|
|
2241
|
+
"content": {
|
|
2242
|
+
"application/json": {
|
|
2243
|
+
"schema": {
|
|
2244
|
+
"$ref": "#/components/schemas/ProductRecommendationSearch"
|
|
2245
|
+
},
|
|
2246
|
+
"examples": {
|
|
2247
|
+
"Search product recommendations by id": {
|
|
2248
|
+
"value": {
|
|
2249
|
+
"product_recommendation_ids": [
|
|
2250
|
+
"bae8d40a-0093-483a-b4f9-3653800b6781"
|
|
2251
|
+
]
|
|
2252
|
+
}
|
|
2253
|
+
},
|
|
2254
|
+
"Search product recommendations by source product and price": {
|
|
2255
|
+
"value": {
|
|
2256
|
+
"catalog_item": {
|
|
2257
|
+
"product_id": "aa1ebf85-f36e-46ff-978c-ed948c646f12",
|
|
2258
|
+
"price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
|
|
2259
|
+
}
|
|
2260
|
+
}
|
|
2261
|
+
},
|
|
2262
|
+
"Search product recommendations by contract": {
|
|
2263
|
+
"value": {
|
|
2264
|
+
"contract_id": "98ffca40-46ab-4288-af10-a478893b2aa2"
|
|
2265
|
+
}
|
|
2266
|
+
}
|
|
2267
|
+
}
|
|
2268
|
+
}
|
|
2269
|
+
}
|
|
2270
|
+
},
|
|
2271
|
+
"responses": {
|
|
2272
|
+
"200": {
|
|
2273
|
+
"description": "The product recommendations result",
|
|
2274
|
+
"content": {
|
|
2275
|
+
"application/json": {
|
|
2276
|
+
"schema": {
|
|
2277
|
+
"$ref": "#/components/schemas/ProductRecommendationResponse"
|
|
2278
|
+
},
|
|
2279
|
+
"examples": {
|
|
2280
|
+
"Product recommendations": {
|
|
2281
|
+
"value": {
|
|
2282
|
+
"hits": 1,
|
|
2283
|
+
"results": [
|
|
2284
|
+
{
|
|
2285
|
+
"_title": "Tarifwechsel 2025",
|
|
2286
|
+
"_created_at": "2025-01-29T15:46:41.014Z",
|
|
2287
|
+
"_updated_at": "2025-01-29T15:46:41.014Z",
|
|
2288
|
+
"name": "Tarifwechsel 2025",
|
|
2289
|
+
"type": "change",
|
|
2290
|
+
"source_product": {
|
|
2291
|
+
"$relation": [
|
|
2292
|
+
{
|
|
2293
|
+
"entity_id": "e2b12b54-d904-42b7-ac44-802d8ebaadf4"
|
|
2294
|
+
}
|
|
2295
|
+
]
|
|
2296
|
+
},
|
|
2297
|
+
"source_price": {
|
|
2298
|
+
"$relation": [
|
|
2299
|
+
{
|
|
2300
|
+
"entity_id": "255877f3-f9c2-483e-9c71-89088c142bfc"
|
|
2301
|
+
}
|
|
2302
|
+
]
|
|
2303
|
+
},
|
|
2304
|
+
"_schema": "product_recommendation",
|
|
2305
|
+
"offers": [
|
|
2306
|
+
{
|
|
2307
|
+
"target_id": "f9aa8757-505b-46bd-9310-605d64849565",
|
|
2308
|
+
"items": [
|
|
2309
|
+
{
|
|
2310
|
+
"product_id": "70ad8a08-46c2-473b-b1c5-8bccfb85e452",
|
|
2311
|
+
"price_id": "26c9c39d-db4a-4132-af2e-86ab5c7b156c"
|
|
2312
|
+
},
|
|
2313
|
+
{
|
|
2314
|
+
"product_id": "dd97a2a4-e48b-43c5-8717-7ac563c67e05",
|
|
2315
|
+
"price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
|
|
2316
|
+
},
|
|
2317
|
+
{
|
|
2318
|
+
"product_id": "aa1ebf85-f36e-46ff-978c-ed948c646f12",
|
|
2319
|
+
"price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
|
|
2320
|
+
}
|
|
2321
|
+
]
|
|
2322
|
+
}
|
|
2323
|
+
],
|
|
2324
|
+
"_id": "6d872912-ef8a-4815-b9db-01744c0828ac",
|
|
2325
|
+
"_org": "739224"
|
|
2326
|
+
}
|
|
2327
|
+
]
|
|
2328
|
+
}
|
|
2329
|
+
}
|
|
2330
|
+
}
|
|
2331
|
+
}
|
|
2332
|
+
}
|
|
2333
|
+
},
|
|
2334
|
+
"400": {
|
|
2335
|
+
"description": "Invalid payload",
|
|
2336
|
+
"content": {
|
|
2337
|
+
"application/json": {
|
|
2338
|
+
"schema": {
|
|
2339
|
+
"$ref": "#/components/schemas/Error"
|
|
2340
|
+
}
|
|
2341
|
+
}
|
|
2342
|
+
}
|
|
2343
|
+
}
|
|
2344
|
+
}
|
|
2345
|
+
}
|
|
1949
2346
|
}
|
|
1950
2347
|
},
|
|
1951
2348
|
"components": {
|
|
@@ -2576,7 +2973,10 @@
|
|
|
2576
2973
|
},
|
|
2577
2974
|
"is_composite_price": {
|
|
2578
2975
|
"description": "The flag for prices that contain price components.",
|
|
2579
|
-
"type": "boolean"
|
|
2976
|
+
"type": "boolean",
|
|
2977
|
+
"enum": [
|
|
2978
|
+
false
|
|
2979
|
+
]
|
|
2580
2980
|
},
|
|
2581
2981
|
"pricing_model": {
|
|
2582
2982
|
"type": "string",
|
|
@@ -2752,19 +3152,22 @@
|
|
|
2752
3152
|
"pricing_model"
|
|
2753
3153
|
]
|
|
2754
3154
|
},
|
|
2755
|
-
"
|
|
3155
|
+
"BaseCompositePrice": {
|
|
2756
3156
|
"allOf": [
|
|
2757
3157
|
{
|
|
2758
3158
|
"$ref": "#/components/schemas/PriceConditions"
|
|
2759
3159
|
}
|
|
2760
3160
|
],
|
|
2761
3161
|
"type": "object",
|
|
2762
|
-
"description": "The price entity
|
|
3162
|
+
"description": "The common properties for a composite price entity, without the price components",
|
|
2763
3163
|
"example": {
|
|
2764
3164
|
"$ref": "#/components/examples/composite-price"
|
|
2765
3165
|
},
|
|
2766
3166
|
"additionalProperties": true,
|
|
2767
3167
|
"readOnly": true,
|
|
3168
|
+
"required": [
|
|
3169
|
+
"is_composite_price"
|
|
3170
|
+
],
|
|
2768
3171
|
"properties": {
|
|
2769
3172
|
"active": {
|
|
2770
3173
|
"type": "boolean",
|
|
@@ -2806,7 +3209,10 @@
|
|
|
2806
3209
|
},
|
|
2807
3210
|
"is_composite_price": {
|
|
2808
3211
|
"description": "The flag for prices that contain price components.",
|
|
2809
|
-
"type": "boolean"
|
|
3212
|
+
"type": "boolean",
|
|
3213
|
+
"enum": [
|
|
3214
|
+
true
|
|
3215
|
+
]
|
|
2810
3216
|
},
|
|
2811
3217
|
"_created_at": {
|
|
2812
3218
|
"description": "The price creation date",
|
|
@@ -2837,6 +3243,58 @@
|
|
|
2837
3243
|
}
|
|
2838
3244
|
}
|
|
2839
3245
|
},
|
|
3246
|
+
"NonHydratedCompositePrice": {
|
|
3247
|
+
"allOf": [
|
|
3248
|
+
{
|
|
3249
|
+
"$ref": "#/components/schemas/BaseCompositePrice"
|
|
3250
|
+
}
|
|
3251
|
+
],
|
|
3252
|
+
"type": "object",
|
|
3253
|
+
"description": "The composite price entity",
|
|
3254
|
+
"properties": {
|
|
3255
|
+
"price_components": {
|
|
3256
|
+
"description": "A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.",
|
|
3257
|
+
"type": "object",
|
|
3258
|
+
"properties": {
|
|
3259
|
+
"$relation": {
|
|
3260
|
+
"type": "array",
|
|
3261
|
+
"items": {
|
|
3262
|
+
"$ref": "#/components/schemas/PriceComponentRelation"
|
|
3263
|
+
}
|
|
3264
|
+
}
|
|
3265
|
+
}
|
|
3266
|
+
}
|
|
3267
|
+
}
|
|
3268
|
+
},
|
|
3269
|
+
"HydratedCompositePrice": {
|
|
3270
|
+
"allOf": [
|
|
3271
|
+
{
|
|
3272
|
+
"$ref": "#/components/schemas/BaseCompositePrice"
|
|
3273
|
+
}
|
|
3274
|
+
],
|
|
3275
|
+
"type": "object",
|
|
3276
|
+
"description": "The composite price entity",
|
|
3277
|
+
"properties": {
|
|
3278
|
+
"price_components": {
|
|
3279
|
+
"description": "A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.",
|
|
3280
|
+
"type": "array",
|
|
3281
|
+
"items": {
|
|
3282
|
+
"$ref": "#/components/schemas/Price"
|
|
3283
|
+
}
|
|
3284
|
+
}
|
|
3285
|
+
}
|
|
3286
|
+
},
|
|
3287
|
+
"CompositePrice": {
|
|
3288
|
+
"oneOf": [
|
|
3289
|
+
{
|
|
3290
|
+
"$ref": "#/components/schemas/NonHydratedCompositePrice"
|
|
3291
|
+
},
|
|
3292
|
+
{
|
|
3293
|
+
"$ref": "#/components/schemas/HydratedCompositePrice"
|
|
3294
|
+
}
|
|
3295
|
+
],
|
|
3296
|
+
"description": "The composite price entity"
|
|
3297
|
+
},
|
|
2840
3298
|
"PriceComponentRelation": {
|
|
2841
3299
|
"type": "object",
|
|
2842
3300
|
"properties": {
|
|
@@ -2928,14 +3386,7 @@
|
|
|
2928
3386
|
}
|
|
2929
3387
|
},
|
|
2930
3388
|
"example": {
|
|
2931
|
-
"
|
|
2932
|
-
"frequency_unit": "weekly",
|
|
2933
|
-
"value": 1000.245,
|
|
2934
|
-
"name": "avg consumption",
|
|
2935
|
-
"metadata": {
|
|
2936
|
-
"journey_title": "energy journey",
|
|
2937
|
-
"step_name": "avg consumption picker"
|
|
2938
|
-
}
|
|
3389
|
+
"$ref": "#/components/examples/price-input-mapping/value"
|
|
2939
3390
|
}
|
|
2940
3391
|
},
|
|
2941
3392
|
"PriceConditions": {
|
|
@@ -3028,14 +3479,9 @@
|
|
|
3028
3479
|
"items": {
|
|
3029
3480
|
"$ref": "#/components/schemas/ExternalFeeMapping"
|
|
3030
3481
|
},
|
|
3031
|
-
"example":
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
"frequency_unit": "weekly",
|
|
3035
|
-
"amount_total": 1000,
|
|
3036
|
-
"amount_total_decimal": "10.00"
|
|
3037
|
-
}
|
|
3038
|
-
]
|
|
3482
|
+
"example": {
|
|
3483
|
+
"$ref": "#/components/examples/external-fee-mappings/value"
|
|
3484
|
+
}
|
|
3039
3485
|
},
|
|
3040
3486
|
"ExternalFeeMapping": {
|
|
3041
3487
|
"type": "object",
|
|
@@ -3062,10 +3508,7 @@
|
|
|
3062
3508
|
}
|
|
3063
3509
|
},
|
|
3064
3510
|
"example": {
|
|
3065
|
-
"
|
|
3066
|
-
"frequency_unit": "weekly",
|
|
3067
|
-
"amount_total": 1000,
|
|
3068
|
-
"amount_total_decimal": "10.00"
|
|
3511
|
+
"$ref": "#/components/examples/external-fee-mapping/value"
|
|
3069
3512
|
}
|
|
3070
3513
|
},
|
|
3071
3514
|
"CatalogSearch": {
|
|
@@ -4081,7 +4524,7 @@
|
|
|
4081
4524
|
"$ref": "#/components/schemas/MetaData"
|
|
4082
4525
|
},
|
|
4083
4526
|
"quantity": {
|
|
4084
|
-
"type": "
|
|
4527
|
+
"type": "number",
|
|
4085
4528
|
"description": "The quantity of products being purchased."
|
|
4086
4529
|
},
|
|
4087
4530
|
"product_id": {
|
|
@@ -4092,17 +4535,17 @@
|
|
|
4092
4535
|
"type": "string",
|
|
4093
4536
|
"description": "The id of the price."
|
|
4094
4537
|
},
|
|
4095
|
-
"is_composite_price": {
|
|
4096
|
-
"description": "The flag for prices that contain price components.",
|
|
4097
|
-
"type": "boolean"
|
|
4098
|
-
},
|
|
4099
4538
|
"description": {
|
|
4100
4539
|
"type": "string",
|
|
4101
4540
|
"description": "An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."
|
|
4102
4541
|
},
|
|
4103
|
-
"
|
|
4542
|
+
"product_description": {
|
|
4104
4543
|
"type": "string",
|
|
4105
|
-
"description": "
|
|
4544
|
+
"description": "The description for the product."
|
|
4545
|
+
},
|
|
4546
|
+
"product_name": {
|
|
4547
|
+
"type": "string",
|
|
4548
|
+
"description": "The name for the product."
|
|
4106
4549
|
},
|
|
4107
4550
|
"price_mappings": {
|
|
4108
4551
|
"description": "Price mapping information required to compute totals",
|
|
@@ -4122,18 +4565,28 @@
|
|
|
4122
4565
|
}
|
|
4123
4566
|
}
|
|
4124
4567
|
},
|
|
4568
|
+
"PriceItemDtoUnion": {
|
|
4569
|
+
"anyOf": [
|
|
4570
|
+
{
|
|
4571
|
+
"$ref": "#/components/schemas/PriceItemDto"
|
|
4572
|
+
},
|
|
4573
|
+
{
|
|
4574
|
+
"$ref": "#/components/schemas/CompositePriceItemDto"
|
|
4575
|
+
}
|
|
4576
|
+
],
|
|
4577
|
+
"discriminator": {
|
|
4578
|
+
"propertyName": "is_composite_price",
|
|
4579
|
+
"mapping": {
|
|
4580
|
+
"false": "#/components/schemas/PriceItemDto",
|
|
4581
|
+
"true": "#/components/schemas/CompositePriceItemDto"
|
|
4582
|
+
}
|
|
4583
|
+
}
|
|
4584
|
+
},
|
|
4125
4585
|
"PriceItemsDto": {
|
|
4126
4586
|
"description": "A valid set of product prices, quantities, (discounts) and taxes from a client.",
|
|
4127
4587
|
"type": "array",
|
|
4128
4588
|
"items": {
|
|
4129
|
-
"
|
|
4130
|
-
{
|
|
4131
|
-
"$ref": "#/components/schemas/PriceItemDto"
|
|
4132
|
-
},
|
|
4133
|
-
{
|
|
4134
|
-
"$ref": "#/components/schemas/CompositePriceItemDto"
|
|
4135
|
-
}
|
|
4136
|
-
]
|
|
4589
|
+
"$ref": "#/components/schemas/PriceItemDtoUnion"
|
|
4137
4590
|
}
|
|
4138
4591
|
},
|
|
4139
4592
|
"BasePriceItemDto": {
|
|
@@ -4201,7 +4654,7 @@
|
|
|
4201
4654
|
"items": {
|
|
4202
4655
|
"oneOf": [
|
|
4203
4656
|
{
|
|
4204
|
-
"$ref": "#/components/schemas/
|
|
4657
|
+
"$ref": "#/components/schemas/CouponItem"
|
|
4205
4658
|
}
|
|
4206
4659
|
]
|
|
4207
4660
|
}
|
|
@@ -4209,113 +4662,128 @@
|
|
|
4209
4662
|
}
|
|
4210
4663
|
},
|
|
4211
4664
|
"PriceItemDto": {
|
|
4665
|
+
"description": "Represents a price input to the pricing library.",
|
|
4212
4666
|
"allOf": [
|
|
4213
4667
|
{
|
|
4214
4668
|
"$ref": "#/components/schemas/BasePriceItemDto"
|
|
4215
|
-
}
|
|
4216
|
-
],
|
|
4217
|
-
"description": "Represents a price input to the pricing library.",
|
|
4218
|
-
"type": "object",
|
|
4219
|
-
"properties": {
|
|
4220
|
-
"type": {
|
|
4221
|
-
"type": "string",
|
|
4222
|
-
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
4223
|
-
"enum": [
|
|
4224
|
-
"one_time",
|
|
4225
|
-
"recurring"
|
|
4226
|
-
]
|
|
4227
|
-
},
|
|
4228
|
-
"billing_period": {
|
|
4229
|
-
"type": "string",
|
|
4230
|
-
"description": "The price billing period.",
|
|
4231
|
-
"enum": [
|
|
4232
|
-
"weekly",
|
|
4233
|
-
"monthly",
|
|
4234
|
-
"every_quarter",
|
|
4235
|
-
"every_6_months",
|
|
4236
|
-
"yearly"
|
|
4237
|
-
]
|
|
4238
|
-
},
|
|
4239
|
-
"unit_amount": {
|
|
4240
|
-
"type": "integer",
|
|
4241
|
-
"description": "The unit amount value"
|
|
4242
|
-
},
|
|
4243
|
-
"unit_amount_gross": {
|
|
4244
|
-
"type": "integer",
|
|
4245
|
-
"description": "The unit gross amount value."
|
|
4246
|
-
},
|
|
4247
|
-
"unit_amount_currency": {
|
|
4248
|
-
"$ref": "#/components/schemas/Currency"
|
|
4249
4669
|
},
|
|
4250
|
-
|
|
4251
|
-
"
|
|
4252
|
-
"
|
|
4253
|
-
|
|
4254
|
-
|
|
4255
|
-
|
|
4256
|
-
|
|
4257
|
-
|
|
4258
|
-
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
"
|
|
4262
|
-
|
|
4263
|
-
|
|
4264
|
-
|
|
4265
|
-
|
|
4266
|
-
|
|
4267
|
-
|
|
4268
|
-
|
|
4269
|
-
{
|
|
4270
|
-
"
|
|
4670
|
+
{
|
|
4671
|
+
"type": "object",
|
|
4672
|
+
"properties": {
|
|
4673
|
+
"type": {
|
|
4674
|
+
"type": "string",
|
|
4675
|
+
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
4676
|
+
"enum": [
|
|
4677
|
+
"one_time",
|
|
4678
|
+
"recurring"
|
|
4679
|
+
]
|
|
4680
|
+
},
|
|
4681
|
+
"billing_period": {
|
|
4682
|
+
"description": "The price billing period.",
|
|
4683
|
+
"oneOf": [
|
|
4684
|
+
{
|
|
4685
|
+
"$ref": "#/components/schemas/BillingPeriod"
|
|
4686
|
+
}
|
|
4687
|
+
]
|
|
4688
|
+
},
|
|
4689
|
+
"unit_amount": {
|
|
4690
|
+
"type": "integer",
|
|
4691
|
+
"description": "The unit amount value"
|
|
4692
|
+
},
|
|
4693
|
+
"unit_amount_gross": {
|
|
4694
|
+
"type": "integer",
|
|
4695
|
+
"description": "The unit gross amount value."
|
|
4696
|
+
},
|
|
4697
|
+
"unit_amount_currency": {
|
|
4698
|
+
"$ref": "#/components/schemas/Currency"
|
|
4699
|
+
},
|
|
4700
|
+
"unit_amount_decimal": {
|
|
4701
|
+
"description": "The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.",
|
|
4702
|
+
"type": "string"
|
|
4703
|
+
},
|
|
4704
|
+
"is_composite_price": {
|
|
4705
|
+
"description": "The flag for prices that contain price components.",
|
|
4706
|
+
"type": "boolean",
|
|
4707
|
+
"enum": [
|
|
4708
|
+
false
|
|
4709
|
+
]
|
|
4710
|
+
},
|
|
4711
|
+
"pricing_model": {
|
|
4712
|
+
"type": "string",
|
|
4713
|
+
"description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `tiered_flatfee` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
|
|
4714
|
+
"enum": [
|
|
4715
|
+
"per_unit",
|
|
4716
|
+
"tiered_graduated",
|
|
4717
|
+
"tiered_volume",
|
|
4718
|
+
"tiered_flatfee",
|
|
4719
|
+
"dynamic_tariff",
|
|
4720
|
+
"external_getag"
|
|
4721
|
+
]
|
|
4722
|
+
},
|
|
4723
|
+
"_price": {
|
|
4724
|
+
"description": "The snapshot of the price linked to the price item.",
|
|
4725
|
+
"allOf": [
|
|
4726
|
+
{
|
|
4727
|
+
"$ref": "#/components/schemas/Price"
|
|
4728
|
+
}
|
|
4729
|
+
]
|
|
4271
4730
|
}
|
|
4272
|
-
|
|
4731
|
+
}
|
|
4273
4732
|
}
|
|
4274
|
-
},
|
|
4275
|
-
"required": [
|
|
4276
|
-
"pricing_model"
|
|
4277
4733
|
]
|
|
4278
4734
|
},
|
|
4279
4735
|
"CompositePriceItemDto": {
|
|
4736
|
+
"description": "Represents a composite price input to the pricing library.",
|
|
4280
4737
|
"allOf": [
|
|
4281
4738
|
{
|
|
4282
4739
|
"$ref": "#/components/schemas/BasePriceItemDto"
|
|
4283
|
-
}
|
|
4284
|
-
],
|
|
4285
|
-
"description": "Represents a composite price input to the pricing library.",
|
|
4286
|
-
"type": "object",
|
|
4287
|
-
"properties": {
|
|
4288
|
-
"item_components": {
|
|
4289
|
-
"type": "array",
|
|
4290
|
-
"description": "Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).",
|
|
4291
|
-
"items": {
|
|
4292
|
-
"$ref": "#/components/schemas/PriceItemDto"
|
|
4293
|
-
}
|
|
4294
4740
|
},
|
|
4295
|
-
|
|
4296
|
-
"type": "array",
|
|
4297
|
-
"description": "The ids of the price components that should be selected for the price calculation.",
|
|
4298
|
-
"items": {
|
|
4299
|
-
"type": "string",
|
|
4300
|
-
"description": "The id of the price component"
|
|
4301
|
-
}
|
|
4302
|
-
},
|
|
4303
|
-
"price_component_coupon_ids": {
|
|
4741
|
+
{
|
|
4304
4742
|
"type": "object",
|
|
4305
|
-
"
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
|
|
4309
|
-
"
|
|
4310
|
-
"
|
|
4311
|
-
"
|
|
4743
|
+
"required": [
|
|
4744
|
+
"is_composite_price"
|
|
4745
|
+
],
|
|
4746
|
+
"properties": {
|
|
4747
|
+
"is_composite_price": {
|
|
4748
|
+
"description": "The flag for prices that contain price components.",
|
|
4749
|
+
"type": "boolean",
|
|
4750
|
+
"enum": [
|
|
4751
|
+
true
|
|
4752
|
+
]
|
|
4753
|
+
},
|
|
4754
|
+
"item_components": {
|
|
4755
|
+
"type": "array",
|
|
4756
|
+
"description": "Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).",
|
|
4757
|
+
"items": {
|
|
4758
|
+
"$ref": "#/components/schemas/PriceItemDto"
|
|
4759
|
+
}
|
|
4760
|
+
},
|
|
4761
|
+
"selected_price_component_ids": {
|
|
4762
|
+
"type": "array",
|
|
4763
|
+
"description": "The ids of the price components that should be selected for the price calculation.",
|
|
4764
|
+
"items": {
|
|
4765
|
+
"type": "string",
|
|
4766
|
+
"description": "The id of the price component"
|
|
4767
|
+
}
|
|
4768
|
+
},
|
|
4769
|
+
"price_component_coupon_ids": {
|
|
4770
|
+
"type": "object",
|
|
4771
|
+
"description": "The map of coupon ids applicable to the price components",
|
|
4772
|
+
"readOnly": true,
|
|
4773
|
+
"additionalProperties": {
|
|
4774
|
+
"type": "array",
|
|
4775
|
+
"items": {
|
|
4776
|
+
"type": "string",
|
|
4777
|
+
"description": "The id of the coupon"
|
|
4778
|
+
}
|
|
4779
|
+
}
|
|
4780
|
+
},
|
|
4781
|
+
"_price": {
|
|
4782
|
+
"$ref": "#/components/schemas/CompositePrice"
|
|
4312
4783
|
}
|
|
4313
4784
|
}
|
|
4314
|
-
},
|
|
4315
|
-
"_price": {
|
|
4316
|
-
"$ref": "#/components/schemas/CompositePrice"
|
|
4317
4785
|
}
|
|
4318
|
-
|
|
4786
|
+
]
|
|
4319
4787
|
},
|
|
4320
4788
|
"TaxAmountDto": {
|
|
4321
4789
|
"type": "object",
|
|
@@ -4377,14 +4845,11 @@
|
|
|
4377
4845
|
"description": "The price type."
|
|
4378
4846
|
},
|
|
4379
4847
|
"billing_period": {
|
|
4380
|
-
"type": "string",
|
|
4381
4848
|
"description": "The price billing period.",
|
|
4382
|
-
"
|
|
4383
|
-
|
|
4384
|
-
|
|
4385
|
-
|
|
4386
|
-
"every_6_months",
|
|
4387
|
-
"yearly"
|
|
4849
|
+
"oneOf": [
|
|
4850
|
+
{
|
|
4851
|
+
"$ref": "#/components/schemas/BillingPeriod"
|
|
4852
|
+
}
|
|
4388
4853
|
]
|
|
4389
4854
|
},
|
|
4390
4855
|
"unit_amount_gross": {
|
|
@@ -4582,7 +5047,17 @@
|
|
|
4582
5047
|
],
|
|
4583
5048
|
"description": "Represents a composite price input to the pricing library.",
|
|
4584
5049
|
"type": "object",
|
|
5050
|
+
"required": [
|
|
5051
|
+
"is_composite_price"
|
|
5052
|
+
],
|
|
4585
5053
|
"properties": {
|
|
5054
|
+
"is_composite_price": {
|
|
5055
|
+
"description": "The flag for prices that contain price components.",
|
|
5056
|
+
"type": "boolean",
|
|
5057
|
+
"enum": [
|
|
5058
|
+
true
|
|
5059
|
+
]
|
|
5060
|
+
},
|
|
4586
5061
|
"item_components": {
|
|
4587
5062
|
"type": "array",
|
|
4588
5063
|
"description": "Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).",
|
|
@@ -4592,6 +5067,21 @@
|
|
|
4592
5067
|
},
|
|
4593
5068
|
"total_details": {
|
|
4594
5069
|
"$ref": "#/components/schemas/TotalDetails"
|
|
5070
|
+
},
|
|
5071
|
+
"_coupons": {
|
|
5072
|
+
"type": "array",
|
|
5073
|
+
"description": "The coupons applicable to the composite price item + related (cashback) amounts",
|
|
5074
|
+
"readOnly": true,
|
|
5075
|
+
"items": {
|
|
5076
|
+
"allOf": [
|
|
5077
|
+
{
|
|
5078
|
+
"$ref": "#/components/schemas/CouponItem"
|
|
5079
|
+
},
|
|
5080
|
+
{
|
|
5081
|
+
"$ref": "#/components/schemas/CashbackAmounts"
|
|
5082
|
+
}
|
|
5083
|
+
]
|
|
5084
|
+
}
|
|
4595
5085
|
}
|
|
4596
5086
|
}
|
|
4597
5087
|
},
|
|
@@ -4774,7 +5264,7 @@
|
|
|
4774
5264
|
"items": {
|
|
4775
5265
|
"oneOf": [
|
|
4776
5266
|
{
|
|
4777
|
-
"$ref": "#/components/schemas/
|
|
5267
|
+
"$ref": "#/components/schemas/CouponItem"
|
|
4778
5268
|
}
|
|
4779
5269
|
]
|
|
4780
5270
|
}
|
|
@@ -4785,35 +5275,9 @@
|
|
|
4785
5275
|
}
|
|
4786
5276
|
}
|
|
4787
5277
|
},
|
|
4788
|
-
"
|
|
5278
|
+
"CashbackAmounts": {
|
|
4789
5279
|
"type": "object",
|
|
4790
5280
|
"properties": {
|
|
4791
|
-
"amount_subtotal": {
|
|
4792
|
-
"type": "integer",
|
|
4793
|
-
"description": "Total of all items before (discounts or) taxes are applied."
|
|
4794
|
-
},
|
|
4795
|
-
"amount_subtotal_decimal": {
|
|
4796
|
-
"type": "string",
|
|
4797
|
-
"description": "Total of all items before (discounts or) taxes are applied, as a string with all the decimal places."
|
|
4798
|
-
},
|
|
4799
|
-
"amount_total": {
|
|
4800
|
-
"type": "integer",
|
|
4801
|
-
"description": "Total of all items after (discounts and) taxes are applied."
|
|
4802
|
-
},
|
|
4803
|
-
"amount_total_decimal": {
|
|
4804
|
-
"type": "string",
|
|
4805
|
-
"description": "Total of all items after (discounts and) taxes are applied, as a string with all the decimal places."
|
|
4806
|
-
},
|
|
4807
|
-
"discount_amount": {
|
|
4808
|
-
"type": "integer",
|
|
4809
|
-
"description": "The discount amount.",
|
|
4810
|
-
"readOnly": true
|
|
4811
|
-
},
|
|
4812
|
-
"discount_amount_decimal": {
|
|
4813
|
-
"type": "string",
|
|
4814
|
-
"description": "The discount amount as a string with all the decimal places.",
|
|
4815
|
-
"readOnly": true
|
|
4816
|
-
},
|
|
4817
5281
|
"cashback_amount": {
|
|
4818
5282
|
"type": "integer",
|
|
4819
5283
|
"description": "The cashback amount.",
|
|
@@ -4825,13 +5289,7 @@
|
|
|
4825
5289
|
"readOnly": true
|
|
4826
5290
|
},
|
|
4827
5291
|
"cashback_period": {
|
|
4828
|
-
"
|
|
4829
|
-
"description": "The cashback period, for now it's limited to either 0 months or 12 months",
|
|
4830
|
-
"enum": [
|
|
4831
|
-
"0",
|
|
4832
|
-
"12"
|
|
4833
|
-
],
|
|
4834
|
-
"nullable": true
|
|
5292
|
+
"$ref": "#/components/schemas/CashbackPeriod"
|
|
4835
5293
|
},
|
|
4836
5294
|
"after_cashback_amount_total": {
|
|
4837
5295
|
"type": "integer",
|
|
@@ -4842,6 +5300,21 @@
|
|
|
4842
5300
|
"type": "string",
|
|
4843
5301
|
"description": "Total amount after cashback is applied as a string with all the decimal places.",
|
|
4844
5302
|
"readOnly": true
|
|
5303
|
+
}
|
|
5304
|
+
}
|
|
5305
|
+
},
|
|
5306
|
+
"DiscountAmounts": {
|
|
5307
|
+
"type": "object",
|
|
5308
|
+
"properties": {
|
|
5309
|
+
"discount_amount": {
|
|
5310
|
+
"type": "integer",
|
|
5311
|
+
"description": "The discount amount.",
|
|
5312
|
+
"readOnly": true
|
|
5313
|
+
},
|
|
5314
|
+
"discount_amount_decimal": {
|
|
5315
|
+
"type": "string",
|
|
5316
|
+
"description": "The discount amount as a string with all the decimal places.",
|
|
5317
|
+
"readOnly": true
|
|
4845
5318
|
},
|
|
4846
5319
|
"discount_percentage": {
|
|
4847
5320
|
"type": "integer",
|
|
@@ -4860,6 +5333,40 @@
|
|
|
4860
5333
|
}
|
|
4861
5334
|
}
|
|
4862
5335
|
},
|
|
5336
|
+
"PriceAmounts": {
|
|
5337
|
+
"type": "object",
|
|
5338
|
+
"properties": {
|
|
5339
|
+
"amount_subtotal": {
|
|
5340
|
+
"type": "integer",
|
|
5341
|
+
"description": "Total of all items before (discounts or) taxes are applied."
|
|
5342
|
+
},
|
|
5343
|
+
"amount_subtotal_decimal": {
|
|
5344
|
+
"type": "string",
|
|
5345
|
+
"description": "Total of all items before (discounts or) taxes are applied, as a string with all the decimal places."
|
|
5346
|
+
},
|
|
5347
|
+
"amount_total": {
|
|
5348
|
+
"type": "integer",
|
|
5349
|
+
"description": "Total of all items after (discounts and) taxes are applied."
|
|
5350
|
+
},
|
|
5351
|
+
"amount_total_decimal": {
|
|
5352
|
+
"type": "string",
|
|
5353
|
+
"description": "Total of all items after (discounts and) taxes are applied, as a string with all the decimal places."
|
|
5354
|
+
}
|
|
5355
|
+
}
|
|
5356
|
+
},
|
|
5357
|
+
"Amounts": {
|
|
5358
|
+
"allOf": [
|
|
5359
|
+
{
|
|
5360
|
+
"$ref": "#/components/schemas/PriceAmounts"
|
|
5361
|
+
},
|
|
5362
|
+
{
|
|
5363
|
+
"$ref": "#/components/schemas/CashbackAmounts"
|
|
5364
|
+
},
|
|
5365
|
+
{
|
|
5366
|
+
"$ref": "#/components/schemas/DiscountAmounts"
|
|
5367
|
+
}
|
|
5368
|
+
]
|
|
5369
|
+
},
|
|
4863
5370
|
"PriceItem": {
|
|
4864
5371
|
"allOf": [
|
|
4865
5372
|
{
|
|
@@ -4880,15 +5387,19 @@
|
|
|
4880
5387
|
"recurring"
|
|
4881
5388
|
]
|
|
4882
5389
|
},
|
|
5390
|
+
"is_composite_price": {
|
|
5391
|
+
"description": "The flag for prices that contain price components.",
|
|
5392
|
+
"type": "boolean",
|
|
5393
|
+
"enum": [
|
|
5394
|
+
false
|
|
5395
|
+
]
|
|
5396
|
+
},
|
|
4883
5397
|
"billing_period": {
|
|
4884
|
-
"type": "string",
|
|
4885
5398
|
"description": "The price billing period.",
|
|
4886
|
-
"
|
|
4887
|
-
|
|
4888
|
-
|
|
4889
|
-
|
|
4890
|
-
"every_6_months",
|
|
4891
|
-
"yearly"
|
|
5399
|
+
"oneOf": [
|
|
5400
|
+
{
|
|
5401
|
+
"$ref": "#/components/schemas/BillingPeriod"
|
|
5402
|
+
}
|
|
4892
5403
|
]
|
|
4893
5404
|
},
|
|
4894
5405
|
"pricing_model": {
|
|
@@ -4980,14 +5491,11 @@
|
|
|
4980
5491
|
"description": "The price type."
|
|
4981
5492
|
},
|
|
4982
5493
|
"billing_period": {
|
|
4983
|
-
"type": "string",
|
|
4984
5494
|
"description": "The price billing period.",
|
|
4985
|
-
"
|
|
4986
|
-
|
|
4987
|
-
|
|
4988
|
-
|
|
4989
|
-
"every_6_months",
|
|
4990
|
-
"yearly"
|
|
5495
|
+
"oneOf": [
|
|
5496
|
+
{
|
|
5497
|
+
"$ref": "#/components/schemas/BillingPeriod"
|
|
5498
|
+
}
|
|
4991
5499
|
]
|
|
4992
5500
|
},
|
|
4993
5501
|
"unit_amount_gross": {
|
|
@@ -5023,13 +5531,7 @@
|
|
|
5023
5531
|
"description": "An amount associated with a specific cashback period.",
|
|
5024
5532
|
"properties": {
|
|
5025
5533
|
"cashback_period": {
|
|
5026
|
-
"
|
|
5027
|
-
"description": "The cashback period, for now it's limited to either 0 months or 12 months",
|
|
5028
|
-
"enum": [
|
|
5029
|
-
"0",
|
|
5030
|
-
"12"
|
|
5031
|
-
],
|
|
5032
|
-
"nullable": true
|
|
5534
|
+
"$ref": "#/components/schemas/CashbackPeriod"
|
|
5033
5535
|
},
|
|
5034
5536
|
"amount_total": {
|
|
5035
5537
|
"type": "integer",
|
|
@@ -5050,14 +5552,11 @@
|
|
|
5050
5552
|
"description": "The price type."
|
|
5051
5553
|
},
|
|
5052
5554
|
"billing_period": {
|
|
5053
|
-
"type": "string",
|
|
5054
5555
|
"description": "The price billing period.",
|
|
5055
|
-
"
|
|
5056
|
-
|
|
5057
|
-
|
|
5058
|
-
|
|
5059
|
-
"every_6_months",
|
|
5060
|
-
"yearly"
|
|
5556
|
+
"oneOf": [
|
|
5557
|
+
{
|
|
5558
|
+
"$ref": "#/components/schemas/BillingPeriod"
|
|
5559
|
+
}
|
|
5061
5560
|
]
|
|
5062
5561
|
},
|
|
5063
5562
|
"amount_total": {
|
|
@@ -5212,7 +5711,7 @@
|
|
|
5212
5711
|
"matched_coupons": {
|
|
5213
5712
|
"type": "array",
|
|
5214
5713
|
"items": {
|
|
5215
|
-
"$ref": "#/components/schemas/
|
|
5714
|
+
"$ref": "#/components/schemas/CouponWithoutPromoCodes"
|
|
5216
5715
|
}
|
|
5217
5716
|
}
|
|
5218
5717
|
}
|
|
@@ -5236,6 +5735,15 @@
|
|
|
5236
5735
|
"yearly"
|
|
5237
5736
|
]
|
|
5238
5737
|
},
|
|
5738
|
+
"CashbackPeriod": {
|
|
5739
|
+
"type": "string",
|
|
5740
|
+
"description": "The cashback period, for now it's limited to either 0 months or 12 months",
|
|
5741
|
+
"enum": [
|
|
5742
|
+
"0",
|
|
5743
|
+
"12"
|
|
5744
|
+
],
|
|
5745
|
+
"nullable": true
|
|
5746
|
+
},
|
|
5239
5747
|
"SalesTax": {
|
|
5240
5748
|
"type": "string",
|
|
5241
5749
|
"enum": [
|
|
@@ -5530,15 +6038,7 @@
|
|
|
5530
6038
|
"_updated_at"
|
|
5531
6039
|
],
|
|
5532
6040
|
"example": {
|
|
5533
|
-
"
|
|
5534
|
-
"_org": "123",
|
|
5535
|
-
"_schema": "contact",
|
|
5536
|
-
"_tags": [
|
|
5537
|
-
"example",
|
|
5538
|
-
"mock"
|
|
5539
|
-
],
|
|
5540
|
-
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
5541
|
-
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
6041
|
+
"$ref": "#/components/examples/entity-item/value"
|
|
5542
6042
|
}
|
|
5543
6043
|
},
|
|
5544
6044
|
"EntityRelation": {
|
|
@@ -5611,7 +6111,8 @@
|
|
|
5611
6111
|
"type": "string"
|
|
5612
6112
|
},
|
|
5613
6113
|
"rate": {
|
|
5614
|
-
"type": "number"
|
|
6114
|
+
"type": "number",
|
|
6115
|
+
"nullable": true
|
|
5615
6116
|
},
|
|
5616
6117
|
"active": {
|
|
5617
6118
|
"type": "boolean"
|
|
@@ -5624,27 +6125,15 @@
|
|
|
5624
6125
|
}
|
|
5625
6126
|
},
|
|
5626
6127
|
"example": {
|
|
5627
|
-
"
|
|
5628
|
-
"type": "VAT",
|
|
5629
|
-
"description": "Tax description",
|
|
5630
|
-
"active": "true",
|
|
5631
|
-
"region": "DE",
|
|
5632
|
-
"region_label": "Germany",
|
|
5633
|
-
"_org": "123",
|
|
5634
|
-
"_schema": "tax",
|
|
5635
|
-
"_tags": [
|
|
5636
|
-
"example",
|
|
5637
|
-
"mock"
|
|
5638
|
-
],
|
|
5639
|
-
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
5640
|
-
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
6128
|
+
"$ref": "#/components/examples/tax/value"
|
|
5641
6129
|
}
|
|
5642
6130
|
},
|
|
5643
6131
|
"TaxBreakdownInfo": {
|
|
5644
6132
|
"type": "object",
|
|
5645
6133
|
"properties": {
|
|
5646
6134
|
"rate": {
|
|
5647
|
-
"type": "number"
|
|
6135
|
+
"type": "number",
|
|
6136
|
+
"nullable": true
|
|
5648
6137
|
},
|
|
5649
6138
|
"type": {
|
|
5650
6139
|
"type": "string",
|
|
@@ -5659,9 +6148,9 @@
|
|
|
5659
6148
|
}
|
|
5660
6149
|
}
|
|
5661
6150
|
},
|
|
5662
|
-
"
|
|
6151
|
+
"BaseCouponCommon": {
|
|
5663
6152
|
"type": "object",
|
|
5664
|
-
"description": "The coupon
|
|
6153
|
+
"description": "The shared properties for the coupon entity and coupon item entity",
|
|
5665
6154
|
"additionalProperties": true,
|
|
5666
6155
|
"required": [
|
|
5667
6156
|
"name",
|
|
@@ -5670,7 +6159,9 @@
|
|
|
5670
6159
|
"_org",
|
|
5671
6160
|
"_schema",
|
|
5672
6161
|
"_created_at",
|
|
5673
|
-
"_updated_at"
|
|
6162
|
+
"_updated_at",
|
|
6163
|
+
"type",
|
|
6164
|
+
"category"
|
|
5674
6165
|
],
|
|
5675
6166
|
"properties": {
|
|
5676
6167
|
"_id": {
|
|
@@ -5757,13 +6248,7 @@
|
|
|
5757
6248
|
]
|
|
5758
6249
|
},
|
|
5759
6250
|
"cashback_period": {
|
|
5760
|
-
"
|
|
5761
|
-
"description": "The cashback period, for now it's limited to either 0 months or 12 months",
|
|
5762
|
-
"enum": [
|
|
5763
|
-
"0",
|
|
5764
|
-
"12"
|
|
5765
|
-
],
|
|
5766
|
-
"nullable": true
|
|
6251
|
+
"$ref": "#/components/schemas/CashbackPeriod"
|
|
5767
6252
|
},
|
|
5768
6253
|
"active": {
|
|
5769
6254
|
"type": "boolean"
|
|
@@ -5771,7 +6256,18 @@
|
|
|
5771
6256
|
"requires_promo_code": {
|
|
5772
6257
|
"type": "boolean",
|
|
5773
6258
|
"description": "Whether the coupon requires a promo code to be applied"
|
|
5774
|
-
}
|
|
6259
|
+
}
|
|
6260
|
+
}
|
|
6261
|
+
},
|
|
6262
|
+
"CouponWithoutPromoCodes": {
|
|
6263
|
+
"type": "object",
|
|
6264
|
+
"description": "The base for the coupon entity without promo codes",
|
|
6265
|
+
"allOf": [
|
|
6266
|
+
{
|
|
6267
|
+
"$ref": "#/components/schemas/BaseCouponCommon"
|
|
6268
|
+
}
|
|
6269
|
+
],
|
|
6270
|
+
"properties": {
|
|
5775
6271
|
"prices": {
|
|
5776
6272
|
"description": "The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.",
|
|
5777
6273
|
"oneOf": [
|
|
@@ -5796,36 +6292,14 @@
|
|
|
5796
6292
|
}
|
|
5797
6293
|
},
|
|
5798
6294
|
"example": {
|
|
5799
|
-
"
|
|
5800
|
-
"_schema": "coupon",
|
|
5801
|
-
"_org": "org_12345",
|
|
5802
|
-
"_created_at": "2024-01-15T10:00:00.000Z",
|
|
5803
|
-
"_updated_at": "2024-01-20T12:00:00.000Z",
|
|
5804
|
-
"_title": "Sample Coupon",
|
|
5805
|
-
"name": "Sample Coupon",
|
|
5806
|
-
"type": "fixed",
|
|
5807
|
-
"fixed_value": 555,
|
|
5808
|
-
"fixed_value_currency": "USD",
|
|
5809
|
-
"fixed_value_decimal": "5.55",
|
|
5810
|
-
"active": true,
|
|
5811
|
-
"prices": {
|
|
5812
|
-
"$relation": [
|
|
5813
|
-
{
|
|
5814
|
-
"entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
|
|
5815
|
-
"_tags": [
|
|
5816
|
-
"discount",
|
|
5817
|
-
"special"
|
|
5818
|
-
],
|
|
5819
|
-
"_schema": "price"
|
|
5820
|
-
}
|
|
5821
|
-
]
|
|
5822
|
-
}
|
|
6295
|
+
"$ref": "#/components/examples/coupon-without-promo-codes/value"
|
|
5823
6296
|
}
|
|
5824
6297
|
},
|
|
5825
6298
|
"Coupon": {
|
|
6299
|
+
"description": "The coupon entity",
|
|
5826
6300
|
"allOf": [
|
|
5827
6301
|
{
|
|
5828
|
-
"$ref": "#/components/schemas/
|
|
6302
|
+
"$ref": "#/components/schemas/CouponWithoutPromoCodes"
|
|
5829
6303
|
}
|
|
5830
6304
|
],
|
|
5831
6305
|
"type": "object",
|
|
@@ -5845,10 +6319,11 @@
|
|
|
5845
6319
|
}
|
|
5846
6320
|
}
|
|
5847
6321
|
},
|
|
5848
|
-
"
|
|
6322
|
+
"CouponItem": {
|
|
6323
|
+
"type": "object",
|
|
5849
6324
|
"allOf": [
|
|
5850
6325
|
{
|
|
5851
|
-
"$ref": "#/components/schemas/
|
|
6326
|
+
"$ref": "#/components/schemas/BaseCouponCommon"
|
|
5852
6327
|
}
|
|
5853
6328
|
]
|
|
5854
6329
|
},
|
|
@@ -5878,10 +6353,7 @@
|
|
|
5878
6353
|
}
|
|
5879
6354
|
},
|
|
5880
6355
|
"example": {
|
|
5881
|
-
"
|
|
5882
|
-
"code": "123456",
|
|
5883
|
-
"has_usage_limit": true,
|
|
5884
|
-
"usage_limit": 10
|
|
6356
|
+
"$ref": "#/components/examples/promo-code/value"
|
|
5885
6357
|
}
|
|
5886
6358
|
},
|
|
5887
6359
|
"RedeemedPromo": {
|
|
@@ -6315,6 +6787,116 @@
|
|
|
6315
6787
|
"pricing_details",
|
|
6316
6788
|
"_meta"
|
|
6317
6789
|
]
|
|
6790
|
+
},
|
|
6791
|
+
"ProductRecommendationSearch": {
|
|
6792
|
+
"description": "Product recommendations request payload",
|
|
6793
|
+
"type": "object",
|
|
6794
|
+
"properties": {
|
|
6795
|
+
"product_recommendation_ids": {
|
|
6796
|
+
"type": "array",
|
|
6797
|
+
"items": {
|
|
6798
|
+
"type": "string",
|
|
6799
|
+
"description": "Product recommendation id"
|
|
6800
|
+
}
|
|
6801
|
+
},
|
|
6802
|
+
"catalog_item": {
|
|
6803
|
+
"type": "object",
|
|
6804
|
+
"description": "The catalog item to be used as source for the recommendation",
|
|
6805
|
+
"properties": {
|
|
6806
|
+
"product_id": {
|
|
6807
|
+
"type": "string",
|
|
6808
|
+
"description": "Product id"
|
|
6809
|
+
},
|
|
6810
|
+
"price_id": {
|
|
6811
|
+
"type": "string",
|
|
6812
|
+
"description": "Product id"
|
|
6813
|
+
}
|
|
6814
|
+
}
|
|
6815
|
+
},
|
|
6816
|
+
"contract_id": {
|
|
6817
|
+
"type": "string",
|
|
6818
|
+
"description": "The contract id to be used as source for the recommendation"
|
|
6819
|
+
}
|
|
6820
|
+
}
|
|
6821
|
+
},
|
|
6822
|
+
"ProductRecommendationResponse": {
|
|
6823
|
+
"description": "Product recommendations request payload",
|
|
6824
|
+
"type": "object",
|
|
6825
|
+
"properties": {
|
|
6826
|
+
"hits": {
|
|
6827
|
+
"type": "number",
|
|
6828
|
+
"description": "The number os results returned."
|
|
6829
|
+
},
|
|
6830
|
+
"results": {
|
|
6831
|
+
"type": "array",
|
|
6832
|
+
"items": {
|
|
6833
|
+
"$ref": "#/components/schemas/ProductRecommendation"
|
|
6834
|
+
}
|
|
6835
|
+
}
|
|
6836
|
+
}
|
|
6837
|
+
},
|
|
6838
|
+
"Offer": {
|
|
6839
|
+
"type": "object",
|
|
6840
|
+
"properties": {
|
|
6841
|
+
"product_id": {
|
|
6842
|
+
"type": "string"
|
|
6843
|
+
},
|
|
6844
|
+
"price_id": {
|
|
6845
|
+
"type": "string"
|
|
6846
|
+
},
|
|
6847
|
+
"target_id": {
|
|
6848
|
+
"type": "string"
|
|
6849
|
+
}
|
|
6850
|
+
}
|
|
6851
|
+
},
|
|
6852
|
+
"ProductRecommendation": {
|
|
6853
|
+
"allOf": [
|
|
6854
|
+
{
|
|
6855
|
+
"$ref": "#/components/schemas/EntityItem"
|
|
6856
|
+
}
|
|
6857
|
+
],
|
|
6858
|
+
"type": "object",
|
|
6859
|
+
"properties": {
|
|
6860
|
+
"source_price": {
|
|
6861
|
+
"type": "object",
|
|
6862
|
+
"description": "Price being used as source",
|
|
6863
|
+
"properties": {
|
|
6864
|
+
"$relation": {
|
|
6865
|
+
"type": "array",
|
|
6866
|
+
"items": {
|
|
6867
|
+
"$ref": "#/components/schemas/EntityRelation"
|
|
6868
|
+
}
|
|
6869
|
+
}
|
|
6870
|
+
}
|
|
6871
|
+
},
|
|
6872
|
+
"source_product": {
|
|
6873
|
+
"type": "object",
|
|
6874
|
+
"description": "Product being used as source",
|
|
6875
|
+
"properties": {
|
|
6876
|
+
"$relation": {
|
|
6877
|
+
"type": "array",
|
|
6878
|
+
"items": {
|
|
6879
|
+
"$ref": "#/components/schemas/EntityRelation"
|
|
6880
|
+
}
|
|
6881
|
+
}
|
|
6882
|
+
}
|
|
6883
|
+
},
|
|
6884
|
+
"type": {
|
|
6885
|
+
"type": "string",
|
|
6886
|
+
"description": "Type of product recommendation",
|
|
6887
|
+
"enum": [
|
|
6888
|
+
"change",
|
|
6889
|
+
"cross-sell",
|
|
6890
|
+
"up-sell"
|
|
6891
|
+
]
|
|
6892
|
+
},
|
|
6893
|
+
"offers": {
|
|
6894
|
+
"type": "array",
|
|
6895
|
+
"items": {
|
|
6896
|
+
"$ref": "#/components/schemas/Offer"
|
|
6897
|
+
}
|
|
6898
|
+
}
|
|
6899
|
+
}
|
|
6318
6900
|
}
|
|
6319
6901
|
},
|
|
6320
6902
|
"examples": {
|
|
@@ -7911,6 +8493,100 @@
|
|
|
7911
8493
|
}
|
|
7912
8494
|
]
|
|
7913
8495
|
}
|
|
8496
|
+
},
|
|
8497
|
+
"entity-item": {
|
|
8498
|
+
"value": {
|
|
8499
|
+
"_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
8500
|
+
"_org": "123",
|
|
8501
|
+
"_schema": "contact",
|
|
8502
|
+
"_tags": [
|
|
8503
|
+
"example",
|
|
8504
|
+
"mock"
|
|
8505
|
+
],
|
|
8506
|
+
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
8507
|
+
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
8508
|
+
}
|
|
8509
|
+
},
|
|
8510
|
+
"tax": {
|
|
8511
|
+
"value": {
|
|
8512
|
+
"_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
8513
|
+
"type": "VAT",
|
|
8514
|
+
"description": "Tax description",
|
|
8515
|
+
"active": "true",
|
|
8516
|
+
"region": "DE",
|
|
8517
|
+
"region_label": "Germany",
|
|
8518
|
+
"_org": "123",
|
|
8519
|
+
"_schema": "tax",
|
|
8520
|
+
"_tags": [
|
|
8521
|
+
"example",
|
|
8522
|
+
"mock"
|
|
8523
|
+
],
|
|
8524
|
+
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
8525
|
+
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
8526
|
+
}
|
|
8527
|
+
},
|
|
8528
|
+
"coupon-without-promo-codes": {
|
|
8529
|
+
"value": {
|
|
8530
|
+
"_id": "123e4567-e89b-12d3-a456-426614174000",
|
|
8531
|
+
"_schema": "coupon",
|
|
8532
|
+
"_org": "org_12345",
|
|
8533
|
+
"_created_at": "2024-01-15T10:00:00.000Z",
|
|
8534
|
+
"_updated_at": "2024-01-20T12:00:00.000Z",
|
|
8535
|
+
"_title": "Sample Coupon",
|
|
8536
|
+
"name": "Sample Coupon",
|
|
8537
|
+
"type": "fixed",
|
|
8538
|
+
"fixed_value": 555,
|
|
8539
|
+
"fixed_value_currency": "USD",
|
|
8540
|
+
"fixed_value_decimal": "5.55",
|
|
8541
|
+
"active": true,
|
|
8542
|
+
"prices": {
|
|
8543
|
+
"$relation": [
|
|
8544
|
+
{
|
|
8545
|
+
"entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
|
|
8546
|
+
"_tags": [
|
|
8547
|
+
"discount",
|
|
8548
|
+
"special"
|
|
8549
|
+
],
|
|
8550
|
+
"_schema": "price"
|
|
8551
|
+
}
|
|
8552
|
+
]
|
|
8553
|
+
}
|
|
8554
|
+
}
|
|
8555
|
+
},
|
|
8556
|
+
"promo-code": {
|
|
8557
|
+
"value": {
|
|
8558
|
+
"id": "123e4567-e89b-12d3-a456-426614174000",
|
|
8559
|
+
"code": "123456",
|
|
8560
|
+
"has_usage_limit": true,
|
|
8561
|
+
"usage_limit": 10
|
|
8562
|
+
}
|
|
8563
|
+
},
|
|
8564
|
+
"price-input-mapping": {
|
|
8565
|
+
"value": {
|
|
8566
|
+
"price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
|
|
8567
|
+
"frequency_unit": "weekly",
|
|
8568
|
+
"value": 1000.245,
|
|
8569
|
+
"name": "avg consumption",
|
|
8570
|
+
"metadata": {
|
|
8571
|
+
"journey_title": "energy journey",
|
|
8572
|
+
"step_name": "avg consumption picker"
|
|
8573
|
+
}
|
|
8574
|
+
}
|
|
8575
|
+
},
|
|
8576
|
+
"external-fee-mapping": {
|
|
8577
|
+
"value": {
|
|
8578
|
+
"price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
|
|
8579
|
+
"frequency_unit": "weekly",
|
|
8580
|
+
"amount_total": 1000,
|
|
8581
|
+
"amount_total_decimal": "10.00"
|
|
8582
|
+
}
|
|
8583
|
+
},
|
|
8584
|
+
"external-fee-mappings": {
|
|
8585
|
+
"value": [
|
|
8586
|
+
{
|
|
8587
|
+
"$ref": "#/components/examples/external-fee-mapping"
|
|
8588
|
+
}
|
|
8589
|
+
]
|
|
7914
8590
|
}
|
|
7915
8591
|
}
|
|
7916
8592
|
}
|