@epilot/pricing-client 1.13.1 → 2.0.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.
Files changed (4) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +643 -53
  3. package/dist/openapi.json +2853 -1107
  4. package/package.json +2 -2
package/dist/openapi.json CHANGED
@@ -2,29 +2,98 @@
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
4
  "title": "Pricing API",
5
- "description": "This API hub sets the foundations for the following Pricing APIs:\n- Order API, used to manage orders in Epilot 360:\n - Pricing features such as automatic calculation of totals and price breakdowns for taxes\n - Product and pricing data validation\n- Shopping Cart API, used to interact with a cart during a customer's checkout session, and it's responsible for providing the following set of features:\n - A unified data model to model a Shopping Cart\n - Cart abandonment recovery\n - Product and pricing data validation\n - Checkout a cart into an order, invoice, or quote\n\n- Product Catalog API, provides a way to query the entire catalog of products and prices.\n - Exposes querying operations to access the customer Product Catalog\n\n- Product Availability Service, provides a way to check for products availability by a set of predefined dimensions.\n",
5
+ "description": "The `pricing-api` hub sets the foundations for the following Pricing APIs:\n\n### Order API\nThis api enables the management of orders in epilot 360, providing features such as:\n - Automatic calculation of totals and price breakdowns for taxes on the Order entity\n - Product and pricing data validation\n\n### Shopping Cart API\nUsed to interact with a cart during a customer's checkout session, providing:\n - An unified data model to model a Shopping Cart\n - Product and pricing data validation\n - Checkout a cart into an order or quote\n\n### Catalog API\nProvides a way to query the entire catalog of products and prices.\n\n### Availability API\nProvides endpoints for querying products availability by a set of predefined dimensions.\n",
6
+ "version": "1.0.0",
7
+ "termsOfService": "https://epilot.cloud/agb",
6
8
  "contact": {
7
- "name": "Maintainers Channel",
8
- "url": "https://epilot.slack.com/archives/C020B4URQNS"
9
- },
10
- "version": "1.0.0"
11
- },
12
- "externalDocs": {
13
- "description": "Read the full docs here",
14
- "url": "https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5459705918/Shopping+Cart+Orders+API"
9
+ "name": "Support",
10
+ "email": "info@epilot.cloud",
11
+ "url": "https://help.epilot.cloud"
12
+ }
15
13
  },
16
14
  "tags": [
17
15
  {
18
- "name": "Order",
19
- "description": "Order Management"
16
+ "name": "Order API",
17
+ "description": "This api enables the management of orders in epilot 360, providing features such as:\n - Automatic calculation of totals and price breakdowns for taxes on the Order entity\n - Product and pricing data validation\n"
18
+ },
19
+ {
20
+ "name": "Cart API",
21
+ "description": "Used to interact with a cart during a customer's checkout session, providing:\n - An unified data model to model a Shopping Cart\n - Product and pricing data validation\n - Checkout a cart into an order or quote\n"
22
+ },
23
+ {
24
+ "name": "Catalog API",
25
+ "description": "Provides a way to query the entire catalog of products and prices.\n"
26
+ },
27
+ {
28
+ "name": "Availability API",
29
+ "description": "Provides endpoints for querying products availability by a set of predefined dimensions.\n"
30
+ },
31
+ {
32
+ "name": "Deprecated Endpoints",
33
+ "description": "Deprecated endpoints.\n"
34
+ },
35
+ {
36
+ "name": "order_schema",
37
+ "x-displayName": "Order",
38
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Order\" exampleRef=\"#/components/examples/order-with-simple-prices\" />\n"
39
+ },
40
+ {
41
+ "name": "order_with_bundles",
42
+ "x-displayName": "Order (with Price Bundles)",
43
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Order\" exampleRef=\"#/components/examples/order-with-price-bundles\" />\n"
44
+ },
45
+ {
46
+ "name": "opportunity_schema",
47
+ "x-displayName": "Opportunity",
48
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Opportunity\" exampleRef=\"#/components/examples/opportunity\" />\n"
49
+ },
50
+ {
51
+ "name": "product_schema",
52
+ "x-displayName": "Product",
53
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Product\" exampleRef=\"#/components/examples/product\" />\n"
54
+ },
55
+ {
56
+ "name": "simple_price_schema",
57
+ "x-displayName": "Price",
58
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Price\" exampleRef=\"#/components/examples/price\" />\n"
59
+ },
60
+ {
61
+ "name": "dynamic_price_schema",
62
+ "x-displayName": "Price Bundle",
63
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PriceBundle\" exampleRef=\"#/components/examples/price-bundle\" />\n"
64
+ }
65
+ ],
66
+ "x-tagGroups": [
67
+ {
68
+ "name": "Commerce Schemas",
69
+ "tags": [
70
+ "order_schema",
71
+ "opportunity_schema"
72
+ ]
73
+ },
74
+ {
75
+ "name": "Pricing Schemas",
76
+ "tags": [
77
+ "product_schema",
78
+ "simple_price_schema",
79
+ "dynamic_price_schema"
80
+ ]
20
81
  },
21
82
  {
22
- "name": "Cart",
23
- "description": "The shopping cart & checkout management operations"
83
+ "name": "Examples",
84
+ "tags": [
85
+ "order_with_bundles"
86
+ ]
24
87
  },
25
88
  {
26
- "name": "Product Catalog",
27
- "description": "Product querying operations"
89
+ "name": "APIs",
90
+ "tags": [
91
+ "Order API",
92
+ "Cart API",
93
+ "Catalog API",
94
+ "Availability API",
95
+ "Deprecated"
96
+ ]
28
97
  }
29
98
  ],
30
99
  "security": [
@@ -32,6 +101,14 @@
32
101
  "EpilotAuth": []
33
102
  }
34
103
  ],
104
+ "servers": [
105
+ {
106
+ "url": "https://pricing-api.sls.epilot.io"
107
+ },
108
+ {
109
+ "url": "https://pricing-api.sls.epilot.io"
110
+ }
111
+ ],
35
112
  "paths": {
36
113
  "/v1/order": {
37
114
  "post": {
@@ -39,7 +116,7 @@
39
116
  "operationId": "createOrder",
40
117
  "summary": "createOrder",
41
118
  "tags": [
42
- "Order"
119
+ "Order API"
43
120
  ],
44
121
  "requestBody": {
45
122
  "required": true,
@@ -81,7 +158,7 @@
81
158
  "operationId": "putOrder",
82
159
  "summary": "putOrder",
83
160
  "tags": [
84
- "Order"
161
+ "Order API"
85
162
  ],
86
163
  "parameters": [
87
164
  {
@@ -136,7 +213,7 @@
136
213
  "summary": "checkoutCart",
137
214
  "security": [],
138
215
  "tags": [
139
- "Cart"
216
+ "Cart API"
140
217
  ],
141
218
  "parameters": [
142
219
  {
@@ -158,10 +235,10 @@
158
235
  },
159
236
  "examples": {
160
237
  "Checkout with a CartID": {
161
- "$ref": "#/components/examples/checkoutWithCartId"
238
+ "$ref": "#/components/examples/checkout-with-cart-id"
162
239
  },
163
240
  "Fast Checkout with a transient Cart": {
164
- "$ref": "#/components/examples/checkoutWithTransientCart"
241
+ "$ref": "#/components/examples/checkout-with-transient-cart"
165
242
  }
166
243
  }
167
244
  }
@@ -177,7 +254,7 @@
177
254
  },
178
255
  "examples": {
179
256
  "Checkout with created order": {
180
- "$ref": "#/components/examples/checkoutResult"
257
+ "$ref": "#/components/examples/checkout-result"
181
258
  }
182
259
  }
183
260
  }
@@ -203,7 +280,7 @@
203
280
  "summary": "searchCatalog",
204
281
  "security": [],
205
282
  "tags": [
206
- "Product Catalog"
283
+ "Catalog API"
207
284
  ],
208
285
  "parameters": [
209
286
  {
@@ -257,7 +334,7 @@
257
334
  "summary": "availabilityCheck",
258
335
  "security": [],
259
336
  "tags": [
260
- "Product Catalog"
337
+ "Availability API"
261
338
  ],
262
339
  "parameters": [
263
340
  {
@@ -379,10 +456,13 @@
379
456
  "/v1/public/opportunity": {
380
457
  "post": {
381
458
  "deprecated": true,
382
- "description": "This API is Deprecated. Please use the Entity API or Submission API to create opportunities. Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.\nThe `opportunity_number` can be used to universally identify an opportunity within epilot platform.\n",
459
+ "description": "This API is Deprecated. Please use the Entity API or Submission API to create opportunities.\n\nEnables the creation of a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.\nThe `opportunity_number` can be used to universally identify an opportunity within epilot platform.\n",
383
460
  "operationId": "$createOpportunity",
384
461
  "summary": "createOpportunity",
385
462
  "security": [],
463
+ "tags": [
464
+ "Deprecated"
465
+ ],
386
466
  "parameters": [
387
467
  {
388
468
  "in": "header",
@@ -485,489 +565,474 @@
485
565
  }
486
566
  }
487
567
  },
488
- "MetaData": {
489
- "description": "A set of key-value pairs.",
490
- "type": "array",
491
- "items": {
492
- "oneOf": [
493
- {
568
+ "Product": {
569
+ "type": "object",
570
+ "description": "The product entity",
571
+ "readOnly": true,
572
+ "additionalProperties": true,
573
+ "example": {
574
+ "$ref": "#/components/examples/product"
575
+ },
576
+ "properties": {
577
+ "code": {
578
+ "type": "string",
579
+ "description": "The product code"
580
+ },
581
+ "type": {
582
+ "type": "string",
583
+ "description": "The type of Product:\n\n| type | description |\n|----| ----|\n| `product` | Represents a physical good |\n| `service` | Represents a service or virtual product |\n",
584
+ "enum": [
585
+ "product",
586
+ "service"
587
+ ]
588
+ },
589
+ "name": {
590
+ "type": "string",
591
+ "description": "The product main name"
592
+ },
593
+ "feature": {
594
+ "type": "array",
595
+ "items": {
494
596
  "type": "object",
495
- "description": "Key value pair entry",
496
597
  "properties": {
497
- "key": {
498
- "type": "string",
499
- "description": "Item key"
598
+ "_tags": {
599
+ "type": "array",
600
+ "description": "An arbitrary set of tags attached to a feature",
601
+ "items": {
602
+ "type": "string"
603
+ }
500
604
  },
501
- "value": {
502
- "type": "string",
503
- "description": "Item value"
605
+ "feature": {
606
+ "type": "string"
504
607
  }
505
608
  }
506
609
  }
507
- ]
508
- }
509
- },
510
- "CatalogSearch": {
511
- "description": "A catalog search payload",
512
- "type": "object",
513
- "properties": {
514
- "q": {
515
- "description": "The query to perform using lucene query syntax.",
516
- "type": "string"
517
- },
518
- "sort": {
519
- "description": "The sort expression to sort the results.",
520
- "type": "string"
521
- },
522
- "from": {
523
- "description": "The index from which to query, used for pagination purposes. Defaults to 0",
524
- "type": "number"
525
- },
526
- "size": {
527
- "description": "The max size of the response, defaults to 2000.",
528
- "type": "number"
529
610
  },
530
- "hydrate": {
531
- "type": "boolean",
532
- "description": "When true, enables entity hydration to resolve nested $relation references in-place.",
533
- "default": false
611
+ "cross_sellable_products": {
612
+ "type": "object",
613
+ "description": "Stores references to products that can be cross sold with the current product.",
614
+ "properties": {
615
+ "$relation": {
616
+ "type": "array",
617
+ "items": {
618
+ "$ref": "#/components/schemas/EntityRelation"
619
+ }
620
+ }
621
+ }
534
622
  },
535
- "availability": {
536
- "$ref": "#/components/schemas/AvailabilityFilters"
537
- }
538
- },
539
- "example": {
540
- "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
541
- "sort": "description ASC",
542
- "from": 0,
543
- "size": 200,
544
- "availability": {
545
- "location": {
546
- "postal_code": "57008,",
547
- "city": "Cologne,",
548
- "street": "Media Park,",
549
- "street_number": "8a"
550
- },
551
- "available_date": {
552
- "value": "2022-05-01"
623
+ "product_images": {
624
+ "type": "object",
625
+ "description": "Stores references to a set of file images of the product",
626
+ "properties": {
627
+ "$relation": {
628
+ "type": "array",
629
+ "items": {
630
+ "$ref": "#/components/schemas/EntityRelation"
631
+ }
632
+ }
553
633
  }
554
- }
555
- },
556
- "required": [
557
- "q"
558
- ]
559
- },
560
- "CatalogSearchResult": {
561
- "description": "The query result payload",
562
- "type": "object",
563
- "properties": {
564
- "hits": {
565
- "type": "number",
566
- "description": "The number os results returned."
567
634
  },
568
- "results": {
569
- "type": "array",
570
- "items": {
571
- "anyOf": [
572
- {
573
- "$ref": "#/components/schemas/Product"
574
- },
575
- {
576
- "$ref": "#/components/schemas/Price"
635
+ "product_downloads": {
636
+ "type": "object",
637
+ "description": "Stores references to a set of files downloadable from the product.\ne.g: tech specifications, quality control sheets, privacy policy agreements\n",
638
+ "properties": {
639
+ "$relation": {
640
+ "type": "array",
641
+ "items": {
642
+ "$ref": "#/components/schemas/EntityRelation"
577
643
  }
578
- ]
644
+ }
579
645
  }
580
- }
581
- },
582
- "example": {
583
- "hits": 2,
584
- "results": [
585
- {
586
- "schema": "product",
587
- "description": "product a"
588
- },
589
- {
590
- "schema": "price",
591
- "unit_amount_decimal": "124.342343434"
646
+ },
647
+ "price_options": {
648
+ "type": "object",
649
+ "description": "A set of [prices](/api/pricing#tag/simple_price_schema) or [price bundles](/api/pricing#tag/dynamic_price_schema) for the current product.",
650
+ "properties": {
651
+ "$relation": {
652
+ "type": "array",
653
+ "items": {
654
+ "$ref": "#/components/schemas/EntityRelation"
655
+ }
656
+ }
592
657
  }
593
- ]
594
- }
595
- },
596
- "AvailabilityCheckParams": {
597
- "description": "Availability check request payload",
598
- "type": "object",
599
- "properties": {
600
- "products": {
601
- "description": "Products to check availability",
658
+ },
659
+ "_availability_files": {
602
660
  "type": "array",
661
+ "description": "Stores references to the availability files that define where this product is available.\nThese files are used when interacting with products via epilot Journeys, thought the AvailabilityCheck block.\n",
603
662
  "items": {
604
- "type": "string",
605
- "description": "Product under availability check"
663
+ "$ref": "#/components/schemas/File"
606
664
  }
607
665
  },
608
- "filters": {
609
- "$ref": "#/components/schemas/AvailabilityFilters"
666
+ "_id": {
667
+ "type": "string",
668
+ "description": "The product id"
669
+ },
670
+ "_title": {
671
+ "type": "string",
672
+ "description": "The autogenerated product title"
673
+ },
674
+ "_org_id": {
675
+ "type": "string",
676
+ "description": "The organization id the product belongs to"
677
+ },
678
+ "_created_at": {
679
+ "type": "string",
680
+ "description": "The product creation date",
681
+ "readOnly": true
682
+ },
683
+ "_updated_at": {
684
+ "type": "string",
685
+ "description": "The product last update date",
686
+ "readOnly": true
610
687
  }
611
- },
612
- "required": [
613
- "products",
614
- "filters"
615
- ]
688
+ }
616
689
  },
617
- "AvailabilityResult": {
618
- "description": "The availability check result payload",
690
+ "Opportunity": {
619
691
  "type": "object",
692
+ "description": "The opportunity entity",
693
+ "additionalProperties": true,
694
+ "example": {
695
+ "$ref": "#/components/examples/opportunity"
696
+ },
620
697
  "properties": {
621
- "available_products": {
622
- "type": "array",
623
- "items": {
624
- "type": "string",
625
- "description": "Available Products"
626
- }
698
+ "opportunity_number": {
699
+ "type": "string",
700
+ "description": "The opportunity id number for the customer (autogenerated if left blank)"
627
701
  },
628
- "check_results": {
629
- "description": "The check result details",
702
+ "opportunity_title": {
703
+ "type": "string",
704
+ "description": "The opportunity title for the opportunity"
705
+ },
706
+ "description": {
707
+ "type": "string",
708
+ "description": "A description to frame this opportunity within its sales process"
709
+ },
710
+ "status": {
711
+ "type": "string",
712
+ "description": "The opportunity status (defined by the opportunity workflow)"
713
+ },
714
+ "due_date": {
715
+ "type": "string",
716
+ "description": "The expiration date"
717
+ },
718
+ "assignee": {
719
+ "description": "The opportunity assignees",
630
720
  "type": "array",
631
721
  "items": {
632
722
  "type": "object",
633
723
  "properties": {
634
- "product_id": {
724
+ "id": {
635
725
  "type": "string"
636
726
  },
637
- "matching_hits": {
638
- "description": "The number of rules matched",
639
- "type": "number"
727
+ "email": {
728
+ "type": "string"
640
729
  },
641
- "matching_error": {
642
- "description": "A set of matching errors when checking availability",
643
- "type": "object",
644
- "additionalProperties": true
645
- }
646
- },
647
- "required": [
648
- "product_id"
649
- ]
650
- }
651
- }
652
- },
653
- "required": [
654
- "available_products"
655
- ],
656
- "example": {
657
- "available_products": [],
658
- "check_results": [
659
- {
660
- "product_id": "my-product-id-123-1",
661
- "matching_hits": 0
662
- },
663
- {
664
- "product_id": "my-product-id-123-2",
665
- "matching_hits": 0
730
+ "display_name": {
731
+ "type": "string"
732
+ },
733
+ "token": {
734
+ "type": "string"
735
+ },
736
+ "image_uri": {
737
+ "type": "string"
738
+ },
739
+ "organization_id": {
740
+ "type": "string"
741
+ },
742
+ "department": {
743
+ "type": "string"
744
+ },
745
+ "preferred_language": {
746
+ "type": "string"
747
+ },
748
+ "status": {
749
+ "type": "string"
750
+ },
751
+ "phone": {
752
+ "type": "string"
753
+ },
754
+ "email_notification_settings": {
755
+ "type": "object"
756
+ },
757
+ "is_signature_enabled": {
758
+ "type": "boolean"
759
+ },
760
+ "created_at": {
761
+ "type": "string"
762
+ }
763
+ }
666
764
  }
667
- ]
668
- }
669
- },
670
- "CartDto": {
671
- "description": "A valid cart payload from a client.",
672
- "properties": {
673
- "metadata": {
674
- "$ref": "#/components/schemas/MetaData"
675
765
  },
676
766
  "customer": {
677
- "$ref": "#/components/schemas/Customer"
767
+ "type": "object",
768
+ "description": "A list of customers related with the opportunity",
769
+ "properties": {
770
+ "$relation": {
771
+ "type": "array",
772
+ "items": {
773
+ "$ref": "#/components/schemas/EntityRelation"
774
+ }
775
+ }
776
+ }
777
+ },
778
+ "dates": {
779
+ "type": "array",
780
+ "description": "A set of dates associated with the opportunity",
781
+ "items": {
782
+ "oneOf": [
783
+ {
784
+ "type": "object",
785
+ "properties": {
786
+ "_tags": {
787
+ "type": "array",
788
+ "description": "The date tags",
789
+ "items": {
790
+ "type": "string"
791
+ }
792
+ },
793
+ "value": {
794
+ "description": "The date value",
795
+ "type": "string"
796
+ }
797
+ }
798
+ }
799
+ ]
800
+ }
678
801
  },
679
802
  "billing_address": {
680
- "$ref": "#/components/schemas/Address"
803
+ "description": "The billing address",
804
+ "type": "object",
805
+ "properties": {
806
+ "$relation_ref": {
807
+ "description": "The relation from which a field is being referenced",
808
+ "type": "array",
809
+ "items": {
810
+ "oneOf": [
811
+ {
812
+ "type": "object",
813
+ "properties": {
814
+ "entity_id": {
815
+ "description": "The id of the referenced entity",
816
+ "type": "string"
817
+ },
818
+ "path": {
819
+ "description": "The path to the target attribute being referenced",
820
+ "type": "string"
821
+ }
822
+ }
823
+ }
824
+ ]
825
+ }
826
+ }
827
+ }
681
828
  },
682
829
  "delivery_address": {
683
- "$ref": "#/components/schemas/Address"
830
+ "description": "The delivery address",
831
+ "type": "object",
832
+ "properties": {
833
+ "$relation_ref": {
834
+ "description": "The relation from which a field is being referenced",
835
+ "type": "array",
836
+ "items": {
837
+ "oneOf": [
838
+ {
839
+ "type": "object",
840
+ "properties": {
841
+ "entity_id": {
842
+ "description": "The id of the referenced entity",
843
+ "type": "string"
844
+ },
845
+ "path": {
846
+ "description": "The path to the target attribute being referenced",
847
+ "type": "string"
848
+ }
849
+ }
850
+ }
851
+ ]
852
+ }
853
+ }
854
+ }
855
+ },
856
+ "address": {
857
+ "description": "A list of additional addresses",
858
+ "type": "object",
859
+ "properties": {
860
+ "$relation_ref": {
861
+ "description": "The relation from which a field is being referenced",
862
+ "type": "array",
863
+ "items": {
864
+ "oneOf": [
865
+ {
866
+ "type": "object",
867
+ "properties": {
868
+ "entity_id": {
869
+ "description": "The id of the referenced entity",
870
+ "type": "string"
871
+ },
872
+ "path": {
873
+ "description": "The path to the target attribute being referenced",
874
+ "type": "string"
875
+ }
876
+ }
877
+ }
878
+ ]
879
+ }
880
+ }
881
+ }
882
+ },
883
+ "items": {
884
+ "type": "object",
885
+ "description": "The order relations items, representing quotes or orders associated with the opportunity",
886
+ "properties": {
887
+ "$relation": {
888
+ "type": "array",
889
+ "items": {
890
+ "$ref": "#/components/schemas/OrderRelation"
891
+ }
892
+ }
893
+ }
894
+ },
895
+ "_org_id": {
896
+ "type": "string",
897
+ "description": "Organization Id the order belongs to"
898
+ },
899
+ "_id": {
900
+ "type": "string",
901
+ "description": "The opportunity id",
902
+ "readOnly": true
903
+ },
904
+ "_created_at": {
905
+ "type": "string",
906
+ "description": "The opportunity creation date",
907
+ "readOnly": true
908
+ },
909
+ "_updated_at": {
910
+ "type": "string",
911
+ "description": "The opportunity last update date",
912
+ "readOnly": true
684
913
  },
685
914
  "source_type": {
686
915
  "type": "string",
687
- "description": "type of source, e.g. journey or manual",
916
+ "description": "Type of source, e.g. journey or manual",
688
917
  "example": "journey"
689
918
  },
690
919
  "source_id": {
691
920
  "type": "string",
692
- "description": "identifier for source e.g. journey ID",
921
+ "description": "Identifier for source e.g. journey ID",
693
922
  "example": "ce99875f-fba9-4fe2-a8f9-afaf52059051"
694
923
  },
695
924
  "source": {
696
- "$ref": "#/components/schemas/OrderSource"
925
+ "$ref": "#/components/schemas/OpportunitySource"
697
926
  },
698
- "additional_addresses": {
927
+ "_tags": {
699
928
  "type": "array",
929
+ "description": "An arbitrary set of tags attached to the opportunity",
700
930
  "items": {
701
- "$ref": "#/components/schemas/Address"
931
+ "type": "string"
702
932
  }
933
+ }
934
+ }
935
+ },
936
+ "Order": {
937
+ "type": "object",
938
+ "description": "The order entity",
939
+ "additionalProperties": true,
940
+ "example": {
941
+ "$ref": "#/components/examples/order-with-simple-prices"
942
+ },
943
+ "properties": {
944
+ "order_number": {
945
+ "type": "string",
946
+ "description": "The order number (customer facing)"
703
947
  },
704
- "payment_method": {
705
- "$ref": "#/components/schemas/PaymentMethod"
948
+ "cart_id": {
949
+ "type": "string",
950
+ "description": "The cart id that originated or is associated with the this order"
706
951
  },
707
- "line_items": {
708
- "$ref": "#/components/schemas/PriceItemsDto"
952
+ "status": {
953
+ "$ref": "#/components/schemas/OrderStatus"
709
954
  },
710
- "files": {
711
- "type": "array",
712
- "description": "An array of file IDs, already upload into the File API, that are related with this cart",
713
- "items": {
714
- "type": "string",
715
- "description": "a string representing a file ID as received from the File API"
955
+ "source_type": {
956
+ "type": "string",
957
+ "description": "Type of source, e.g. journey or manual",
958
+ "example": "journey"
959
+ },
960
+ "source_id": {
961
+ "type": "string",
962
+ "description": "Identifier for source e.g. journey ID",
963
+ "example": "ce99875f-fba9-4fe2-a8f9-afaf52059051"
964
+ },
965
+ "source": {
966
+ "$ref": "#/components/schemas/OrderSource"
967
+ },
968
+ "metadata": {
969
+ "$ref": "#/components/schemas/MetaData"
970
+ },
971
+ "customer": {
972
+ "type": "object",
973
+ "description": "A list of customers related with the opportunity",
974
+ "properties": {
975
+ "$relation": {
976
+ "type": "array",
977
+ "items": {
978
+ "$ref": "#/components/schemas/EntityRelation"
979
+ }
980
+ }
716
981
  }
717
982
  },
718
- "status": {
719
- "$ref": "#/components/schemas/OrderStatus"
983
+ "billing_first_name": {
984
+ "type": "string",
985
+ "description": "The billing contact first name"
720
986
  },
721
- "tags": {
987
+ "billing_last_name": {
988
+ "type": "string",
989
+ "description": "The billing contact last name"
990
+ },
991
+ "billing_company_name": {
992
+ "type": "string",
993
+ "description": "The billing account name"
994
+ },
995
+ "billing_vat": {
996
+ "type": "string",
997
+ "description": "The billing account VAT"
998
+ },
999
+ "billing_email": {
1000
+ "type": "string",
1001
+ "description": "The billing email"
1002
+ },
1003
+ "billing_phone": {
1004
+ "type": "string",
1005
+ "description": "The billing phone"
1006
+ },
1007
+ "billing_address": {
722
1008
  "type": "array",
1009
+ "description": "The billing address",
723
1010
  "items": {
724
- "type": "string"
1011
+ "$ref": "#/components/schemas/Address"
725
1012
  }
726
1013
  },
727
- "journey_data": {
728
- "type": "object",
729
- "additionalProperties": true
730
- },
731
- "consents": {
732
- "type": "object",
733
- "additionalProperties": true
734
- }
735
- },
736
- "required": [
737
- "line_items"
738
- ]
739
- },
740
- "CheckoutCart": {
741
- "type": "object",
742
- "description": "The cart checkout request payload",
743
- "properties": {
744
- "cart": {
745
- "anyOf": [
746
- {
747
- "description": "the cart id",
748
- "type": "string"
749
- },
1014
+ "currency": {
1015
+ "description": "The order main currency",
1016
+ "oneOf": [
750
1017
  {
751
- "$ref": "#/components/schemas/CartDto"
1018
+ "$ref": "#/components/schemas/Currency"
752
1019
  }
753
1020
  ]
754
1021
  },
755
- "mode": {
756
- "$ref": "#/components/schemas/CheckoutMode"
757
- }
758
- }
759
- },
760
- "CheckoutCartResult": {
761
- "type": "object",
762
- "description": "The cart checkout result",
763
- "properties": {
764
- "order": {
765
- "$ref": "#/components/schemas/Order"
766
- }
767
- }
768
- },
769
- "CheckoutMode": {
770
- "type": "string",
771
- "description": "The checkout mode for the cart checkout.",
772
- "enum": [
773
- "create_order",
774
- "create_invoice",
775
- "create_quote"
776
- ]
777
- },
778
- "OrderStatus": {
779
- "type": "string",
780
- "enum": [
781
- "draft",
782
- "quote",
783
- "placed",
784
- "cancelled",
785
- "completed"
786
- ],
787
- "description": "The order status"
788
- },
789
- "PriceItemsDto": {
790
- "description": "A valid set of product prices, quantities, (discounts) and taxes from a client.",
791
- "type": "array",
792
- "items": {
793
- "oneOf": [
794
- {
795
- "$ref": "#/components/schemas/PriceItemDto"
796
- }
797
- ]
798
- }
799
- },
800
- "PriceItemDto": {
801
- "description": "Represents a valid price item from a client.",
802
- "type": "object",
803
- "properties": {
804
- "metadata": {
805
- "$ref": "#/components/schemas/MetaData"
806
- },
807
- "quantity": {
808
- "type": "integer",
809
- "description": "The quantity of products being purchased."
810
- },
811
- "description": {
812
- "type": "string",
813
- "description": "An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."
814
- },
815
- "product_id": {
816
- "type": "string",
817
- "description": "The id of the product."
818
- },
819
- "price_id": {
820
- "type": "string",
821
- "description": "The id of the price."
822
- },
823
- "taxes": {
1022
+ "delivery_address": {
824
1023
  "type": "array",
825
- "description": "The taxes applied to the price item.",
826
- "readOnly": true,
1024
+ "description": "The delivery address",
827
1025
  "items": {
828
- "oneOf": [
829
- {
830
- "$ref": "#/components/schemas/TaxAmountDto"
831
- }
832
- ]
1026
+ "$ref": "#/components/schemas/Address"
833
1027
  }
834
1028
  },
835
- "recurrences": {
1029
+ "payment_method": {
836
1030
  "type": "array",
837
- "description": "The taxes applied to the price item.",
838
- "readOnly": true,
1031
+ "description": "The payment method details for the order",
839
1032
  "items": {
840
- "oneOf": [
841
- {
842
- "$ref": "#/components/schemas/RecurrenceAmountDto"
843
- }
844
- ]
1033
+ "$ref": "#/components/schemas/PaymentMethod"
845
1034
  }
846
1035
  },
847
- "_price": {
848
- "$ref": "#/components/schemas/Price"
849
- },
850
- "_product": {
851
- "description": "The product linked to the price item.",
852
- "$ref": "#/components/schemas/Product"
853
- }
854
- }
855
- },
856
- "TaxAmountDto": {
857
- "type": "object",
858
- "description": "A valid tax rate from a client.",
859
- "properties": {
860
- "rate": {
861
- "type": "string",
862
- "description": "The tax rate applied."
863
- },
864
- "tax": {
865
- "description": "The tax applied.",
866
- "oneOf": [
867
- {
868
- "$ref": "#/components/schemas/Tax"
869
- }
870
- ]
871
- }
872
- }
873
- },
874
- "OrderSource": {
875
- "type": "object",
876
- "description": "Order Source",
877
- "properties": {
878
- "http": {
879
- "type": "string",
880
- "description": "Link path for the source",
881
- "example": "/app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939"
882
- },
883
- "title": {
884
- "type": "string",
885
- "description": "Title for the source",
886
- "example": "Journey: PH Journey"
887
- }
888
- }
889
- },
890
- "OpportunitySource": {
891
- "type": "object",
892
- "description": "Order Source",
893
- "properties": {
894
- "http": {
895
- "type": "string",
896
- "description": "Link path for the source",
897
- "example": "/app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939"
898
- },
899
- "title": {
900
- "type": "string",
901
- "description": "Title for the source",
902
- "example": "Journey: PH Journey"
903
- }
904
- }
905
- },
906
- "RecurrenceAmountDto": {
907
- "type": "object",
908
- "description": "An amount associated with a specific recurrence.",
909
- "properties": {
910
- "type": {
911
- "type": "string",
912
- "description": "The price type."
913
- },
914
- "billing_period": {
915
- "type": "string",
916
- "description": "The price billing period."
917
- },
918
- "amount_subtotal": {
919
- "type": "integer",
920
- "description": "Total of all items, with same recurrence, before (discounts or) taxes are applied."
921
- },
922
- "amount_total": {
923
- "type": "integer",
924
- "description": "Total of all items, with same recurrence, after (discounts and) taxes are applied."
925
- },
926
- "amount_tax": {
927
- "type": "integer",
928
- "description": "Total of all items taxes, with same recurrence."
929
- }
930
- },
931
- "required": [
932
- "type",
933
- "amount_subtotal",
934
- "amount_total"
935
- ]
936
- },
937
- "Cart": {
938
- "description": "Supports shopping for products and services until ready for checkout.",
939
- "properties": {
940
- "id": {
941
- "type": "string",
942
- "description": "The cart identifier"
943
- },
944
- "org_id": {
945
- "type": "string",
946
- "description": "The user's Organization Id the cart belongs to",
947
- "readOnly": true
948
- },
949
- "status": {
950
- "enum": [
951
- "open",
952
- "complete",
953
- "expired"
954
- ],
955
- "type": "string",
956
- "readOnly": true,
957
- "description": "The status of the Cart:\n- open - the cart checkout is still in progress. Payment processing has not started\n- complete - the cart checkout is complete. Payment processing may still be in progress\n- expired - the cart checkout has expired. No further processing will occur\n"
958
- },
959
- "customer": {
960
- "$ref": "#/components/schemas/Customer"
961
- },
962
- "billing_address": {
963
- "$ref": "#/components/schemas/Address"
964
- },
965
- "delivery_address": {
966
- "$ref": "#/components/schemas/Address"
967
- },
968
- "metadata": {
969
- "$ref": "#/components/schemas/MetaData"
970
- },
971
1036
  "line_items": {
972
1037
  "$ref": "#/components/schemas/PriceItems"
973
1038
  },
@@ -984,413 +1049,666 @@
984
1049
  "total_details": {
985
1050
  "$ref": "#/components/schemas/TotalDetails"
986
1051
  },
987
- "created_at": {
988
- "readOnly": true,
1052
+ "_org_id": {
989
1053
  "type": "string",
990
- "format": "date-time"
1054
+ "description": "Organization Id the order belongs to"
991
1055
  },
992
- "updated_at": {
993
- "readOnly": true,
1056
+ "_id": {
994
1057
  "type": "string",
995
- "format": "date-time"
1058
+ "description": "The order id",
1059
+ "readOnly": true
1060
+ },
1061
+ "_created_at": {
1062
+ "type": "string",
1063
+ "description": "The order creation date",
1064
+ "readOnly": true
1065
+ },
1066
+ "_updated_at": {
1067
+ "type": "string",
1068
+ "description": "The order last update date",
1069
+ "readOnly": true
1070
+ },
1071
+ "_tags": {
1072
+ "type": "array",
1073
+ "description": "An arbitrary set of tags attached to the order",
1074
+ "items": {
1075
+ "type": "string"
1076
+ }
996
1077
  }
997
1078
  }
998
1079
  },
999
- "Currency": {
1000
- "type": "string",
1001
- "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.\nISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html\n",
1002
- "example": "EUR"
1003
- },
1004
- "Opportunity": {
1080
+ "Price": {
1005
1081
  "type": "object",
1006
- "description": "The opportunity entity",
1082
+ "description": "The price entity schema for simple pricing",
1083
+ "example": {
1084
+ "$ref": "#/components/examples/price"
1085
+ },
1007
1086
  "additionalProperties": true,
1087
+ "readOnly": true,
1008
1088
  "properties": {
1009
- "opportunity_number": {
1010
- "type": "string",
1011
- "description": "The opportunity id number for the customer (autogenerated if left blank)"
1012
- },
1013
- "description": {
1014
- "type": "string",
1015
- "description": "A description to frame this opportunity within its sales process"
1089
+ "active": {
1090
+ "type": "boolean",
1091
+ "description": "Whether the price can be used for new purchases."
1016
1092
  },
1017
- "status": {
1093
+ "billing_scheme": {
1018
1094
  "type": "string",
1019
- "description": "The opportunity status",
1095
+ "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`.\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` indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.\n\n⚠️ Tiered pricing is **not supported** yet.\n",
1020
1096
  "enum": [
1021
- "lead",
1022
- "qualification",
1023
- "validation",
1024
- "offering",
1025
- "supply",
1026
- "approval",
1027
- "operations",
1028
- "complete"
1097
+ "per_unit"
1029
1098
  ]
1030
1099
  },
1031
- "items": {
1100
+ "description": {
1101
+ "type": "string",
1102
+ "description": "A brief description of the price."
1103
+ },
1104
+ "sales_tax": {
1105
+ "deprecated": true,
1106
+ "description": "The default tax rate applicable to the product.\nThis field is deprecated, use the new `tax` attribute.\n",
1032
1107
  "oneOf": [
1033
1108
  {
1109
+ "$ref": "#/components/schemas/SalesTax"
1110
+ }
1111
+ ]
1112
+ },
1113
+ "tax": {
1114
+ "type": "object",
1115
+ "description": "The default tax rate applied to the price",
1116
+ "properties": {
1117
+ "$relation": {
1034
1118
  "type": "array",
1035
- "description": "An array of order when the opportunity entity is hydrated",
1036
1119
  "items": {
1037
- "$ref": "#/components/schemas/Order"
1038
- }
1039
- },
1040
- {
1041
- "type": "object",
1042
- "description": "The order relations items, representing quotes or orders associated with the opportunity",
1043
- "properties": {
1044
- "$relation": {
1045
- "type": "array",
1046
- "items": {
1047
- "$ref": "#/components/schemas/OrderRelation"
1048
- }
1049
- }
1120
+ "$ref": "#/components/schemas/EntityRelation"
1050
1121
  }
1051
1122
  }
1052
- ]
1123
+ }
1053
1124
  },
1054
- "_org_id": {
1125
+ "tax_behavior": {
1055
1126
  "type": "string",
1056
- "description": "Organization Id the order belongs to"
1127
+ "description": "Specifies whether the price is considered `inclusive` of taxes or `exclusive` of taxes.\nOne of `inclusive`, `exclusive`, or `unspecified`.\n",
1128
+ "enum": [
1129
+ "inclusive",
1130
+ "exclusive"
1131
+ ]
1057
1132
  },
1058
- "_id": {
1133
+ "tiers_mode": {
1134
+ "description": "Defines the tiered pricing type of the price.",
1059
1135
  "type": "string",
1060
- "readOnly": true
1136
+ "enum": [
1137
+ "standard"
1138
+ ]
1061
1139
  },
1062
- "_created_at": {
1140
+ "type": {
1063
1141
  "type": "string",
1064
- "readOnly": true
1142
+ "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
1143
+ "enum": [
1144
+ "one_time",
1145
+ "recurring"
1146
+ ]
1065
1147
  },
1066
- "_updated_at": {
1067
- "type": "string",
1068
- "readOnly": true
1148
+ "billing_period": {
1149
+ "description": "For recurring prices `billing_period` defines the default extent of the recurrence.",
1150
+ "oneOf": [
1151
+ {
1152
+ "$ref": "#/components/schemas/BillingPeriod"
1153
+ }
1154
+ ]
1069
1155
  },
1070
- "source_type": {
1071
- "type": "string",
1072
- "description": "type of source, e.g. journey or manual",
1073
- "example": "journey"
1156
+ "unit_amount": {
1157
+ "description": "The unit amount in cents to be charged, represented as a whole integer if possible.",
1158
+ "type": "number"
1074
1159
  },
1075
- "source_id": {
1076
- "type": "string",
1077
- "description": "identifier for source e.g. journey ID",
1078
- "example": "ce99875f-fba9-4fe2-a8f9-afaf52059051"
1160
+ "unit_amount_decimal": {
1161
+ "description": "The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.",
1162
+ "type": "string"
1079
1163
  },
1080
- "source": {
1081
- "$ref": "#/components/schemas/OpportunitySource"
1164
+ "unit_amount_currency": {
1165
+ "description": "Three-letter ISO currency code, in lowercase.",
1166
+ "oneOf": [
1167
+ {
1168
+ "$ref": "#/components/schemas/Currency"
1169
+ }
1170
+ ]
1082
1171
  },
1083
- "_tags": {
1084
- "type": "array",
1085
- "items": {
1086
- "type": "string"
1087
- }
1088
- }
1089
- }
1090
- },
1091
- "OrderRelation": {
1092
- "type": "object",
1093
- "description": "An order relation reference",
1094
- "properties": {
1095
- "entity_id": {
1172
+ "price_display_in_journeys": {
1173
+ "description": "Defines the way the price amount is display in epilot journeys.",
1096
1174
  "type": "string",
1097
- "description": "The relation order id"
1175
+ "enum": [
1176
+ "show_price",
1177
+ "show_as_starting_price",
1178
+ "show_as_on_request"
1179
+ ]
1098
1180
  },
1099
- "_tags": {
1100
- "type": "array",
1101
- "items": {
1102
- "type": "string",
1103
- "description": "The tags array associated with the relation"
1104
- }
1105
- }
1106
- }
1107
- },
1108
- "OrderPayload": {
1109
- "type": "object",
1110
- "description": "Order Entity Payload",
1111
- "properties": {
1112
- "status": {
1113
- "$ref": "#/components/schemas/OrderStatus"
1181
+ "billing_duration_amount": {
1182
+ "description": "The billing period duration",
1183
+ "type": "number"
1114
1184
  },
1115
- "line_items": {
1116
- "$ref": "#/components/schemas/PriceItems"
1185
+ "billing_duration_unit": {
1186
+ "description": "The billing period duration unit",
1187
+ "type": "string",
1188
+ "enum": [
1189
+ "weeks",
1190
+ "months",
1191
+ "years"
1192
+ ]
1117
1193
  },
1118
- "source_type": {
1194
+ "notice_time_amount": {
1195
+ "description": "The notice period duration",
1196
+ "type": "number"
1197
+ },
1198
+ "notice_time_unit": {
1199
+ "description": "The notice period duration unit",
1119
1200
  "type": "string",
1120
- "description": "type of source, e.g. journey or manual",
1121
- "example": "journey"
1201
+ "enum": [
1202
+ "weeks",
1203
+ "months",
1204
+ "years"
1205
+ ]
1122
1206
  },
1123
- "currency": {
1124
- "$ref": "#/components/schemas/Currency"
1207
+ "termination_time_amount": {
1208
+ "description": "The termination period duration",
1209
+ "type": "number"
1125
1210
  },
1126
- "contact": {
1127
- "readOnly": true,
1211
+ "termination_time_unit": {
1212
+ "description": "The termination period duration unit",
1128
1213
  "type": "string",
1129
- "description": "The id of an existing contact."
1214
+ "enum": [
1215
+ "weeks",
1216
+ "months",
1217
+ "years"
1218
+ ]
1130
1219
  },
1131
- "billing_first_name": {
1132
- "type": "string"
1220
+ "renewal_duration_amount": {
1221
+ "description": "The renewal period duration",
1222
+ "type": "number"
1133
1223
  },
1134
- "billing_last_name": {
1135
- "type": "string"
1224
+ "renewal_duration_unit": {
1225
+ "description": "The renewal period duration unit",
1226
+ "type": "string",
1227
+ "enum": [
1228
+ "weeks",
1229
+ "months",
1230
+ "years"
1231
+ ]
1136
1232
  },
1137
- "billing_company_name": {
1233
+ "_created_at": {
1234
+ "description": "The price creation date",
1138
1235
  "type": "string"
1139
1236
  },
1140
- "billing_vat": {
1237
+ "_id": {
1238
+ "description": "The price id",
1141
1239
  "type": "string"
1142
1240
  },
1143
- "billing_email": {
1241
+ "_title": {
1242
+ "description": "The price autogenerated title",
1144
1243
  "type": "string"
1145
1244
  },
1146
- "billing_phone": {
1245
+ "_updated_at": {
1246
+ "description": "The price last update date",
1147
1247
  "type": "string"
1148
1248
  },
1149
- "billing_address": {
1150
- "type": "array",
1151
- "items": {
1152
- "$ref": "#/components/schemas/Address"
1153
- }
1154
- },
1155
- "delivery_address": {
1156
- "type": "array",
1157
- "items": {
1158
- "$ref": "#/components/schemas/Address"
1159
- }
1160
- },
1161
- "payment_method": {
1162
- "type": "array",
1163
- "items": {
1164
- "$ref": "#/components/schemas/PaymentMethod"
1165
- }
1249
+ "_org_id": {
1250
+ "type": "string",
1251
+ "description": "The organization id the price belongs to"
1166
1252
  },
1167
1253
  "_tags": {
1168
1254
  "type": "array",
1255
+ "description": "An arbitrary set of tags attached to the price",
1169
1256
  "items": {
1170
1257
  "type": "string"
1171
1258
  }
1172
1259
  }
1173
1260
  }
1174
1261
  },
1175
- "Order": {
1262
+ "PriceBundle": {
1176
1263
  "type": "object",
1177
- "description": "The order entity",
1264
+ "description": "The price entity schema for dynamic pricing",
1265
+ "example": {
1266
+ "$ref": "#/components/examples/price-bundle"
1267
+ },
1178
1268
  "additionalProperties": true,
1269
+ "readOnly": true,
1179
1270
  "properties": {
1180
- "order_number": {
1181
- "type": "string",
1182
- "description": "The order id number for the customer"
1183
- },
1184
- "cart_id": {
1185
- "type": "string",
1186
- "description": "The cart id that originated or is associated with the order"
1187
- },
1188
- "status": {
1189
- "$ref": "#/components/schemas/OrderStatus"
1190
- },
1191
- "source_type": {
1192
- "type": "string",
1193
- "description": "type of source, e.g. journey or manual",
1194
- "example": "journey"
1271
+ "active": {
1272
+ "type": "boolean",
1273
+ "description": "Whether the price can be used for new purchases."
1195
1274
  },
1196
- "source_id": {
1275
+ "description": {
1197
1276
  "type": "string",
1198
- "description": "identifier for source e.g. journey ID",
1199
- "example": "ce99875f-fba9-4fe2-a8f9-afaf52059051"
1277
+ "description": "A brief description of the price."
1200
1278
  },
1201
- "source": {
1202
- "$ref": "#/components/schemas/OrderSource"
1203
- },
1204
- "metadata": {
1205
- "$ref": "#/components/schemas/MetaData"
1206
- },
1207
- "billing_first_name": {
1208
- "type": "string"
1279
+ "price_components": {
1280
+ "type": "object",
1281
+ "description": "A set of [price](/api/pricing#tag/simple_price_schema) components that define the price bundle.",
1282
+ "properties": {
1283
+ "$relation": {
1284
+ "type": "array",
1285
+ "items": {
1286
+ "$ref": "#/components/schemas/PriceComponentRelation"
1287
+ }
1288
+ }
1289
+ }
1209
1290
  },
1210
- "billing_last_name": {
1291
+ "_created_at": {
1292
+ "description": "The price creation date",
1211
1293
  "type": "string"
1212
1294
  },
1213
- "billing_company_name": {
1295
+ "_id": {
1296
+ "description": "The price id",
1214
1297
  "type": "string"
1215
1298
  },
1216
- "billing_vat": {
1299
+ "_title": {
1300
+ "description": "The price autogenerated title",
1217
1301
  "type": "string"
1218
1302
  },
1219
- "billing_email": {
1303
+ "_updated_at": {
1304
+ "description": "The price last update date",
1220
1305
  "type": "string"
1221
1306
  },
1222
- "billing_phone": {
1223
- "type": "string"
1307
+ "_org_id": {
1308
+ "type": "string",
1309
+ "description": "The organization id the price belongs to"
1224
1310
  },
1225
- "billing_address": {
1311
+ "_tags": {
1226
1312
  "type": "array",
1313
+ "description": "An arbitrary set of tags attached to the price bundle",
1227
1314
  "items": {
1228
- "$ref": "#/components/schemas/Address"
1315
+ "type": "string"
1229
1316
  }
1317
+ }
1318
+ }
1319
+ },
1320
+ "PriceComponentRelation": {
1321
+ "type": "object",
1322
+ "properties": {
1323
+ "entity_id": {
1324
+ "description": "The id of the price component",
1325
+ "type": "string"
1230
1326
  },
1231
- "currency": {
1232
- "$ref": "#/components/schemas/Currency"
1327
+ "quantity": {
1328
+ "description": "By default, the quantity is set to 1, when greater than 1 this value is used as a multiplicative factor.\nE.g: 16 x Solar Modules - Premium price.\n",
1329
+ "type": "number"
1233
1330
  },
1234
- "delivery_address": {
1331
+ "_tags": {
1235
1332
  "type": "array",
1333
+ "description": "An arbitrary set of tags attached to the bundle - component relation",
1236
1334
  "items": {
1237
- "$ref": "#/components/schemas/Address"
1335
+ "type": "string"
1238
1336
  }
1239
- },
1240
- "payment_method": {
1241
- "type": "array",
1242
- "items": {
1243
- "$ref": "#/components/schemas/PaymentMethod"
1337
+ }
1338
+ }
1339
+ },
1340
+ "MetaData": {
1341
+ "description": "A set of key-value pairs used to store meta data information about an entity.",
1342
+ "type": "array",
1343
+ "items": {
1344
+ "oneOf": [
1345
+ {
1346
+ "type": "object",
1347
+ "description": "Key value pair entry",
1348
+ "properties": {
1349
+ "key": {
1350
+ "type": "string",
1351
+ "description": "Item key"
1352
+ },
1353
+ "value": {
1354
+ "type": "string",
1355
+ "description": "Item value"
1356
+ }
1357
+ }
1244
1358
  }
1359
+ ]
1360
+ }
1361
+ },
1362
+ "CatalogSearch": {
1363
+ "description": "A catalog search payload",
1364
+ "type": "object",
1365
+ "properties": {
1366
+ "q": {
1367
+ "description": "The query to perform using lucene query syntax.",
1368
+ "type": "string"
1245
1369
  },
1246
- "contact": {
1247
- "readOnly": true,
1248
- "type": "string",
1249
- "description": "The id of an existing contact."
1250
- },
1251
- "line_items": {
1252
- "$ref": "#/components/schemas/PriceItems"
1253
- },
1254
- "amount_subtotal": {
1255
- "readOnly": true,
1256
- "type": "integer",
1257
- "description": "Total of all items before (discounts or) taxes are applied."
1258
- },
1259
- "amount_total": {
1260
- "readOnly": true,
1261
- "type": "integer",
1262
- "description": "Total of all items after (discounts and) taxes are applied."
1263
- },
1264
- "total_details": {
1265
- "$ref": "#/components/schemas/TotalDetails"
1370
+ "sort": {
1371
+ "description": "The sort expression to sort the results.",
1372
+ "type": "string"
1266
1373
  },
1267
- "_org_id": {
1268
- "type": "string",
1269
- "description": "Organization Id the order belongs to"
1374
+ "from": {
1375
+ "description": "The index from which to query, used for pagination purposes. Defaults to 0",
1376
+ "type": "number"
1270
1377
  },
1271
- "_id": {
1272
- "type": "string",
1273
- "readOnly": true
1378
+ "size": {
1379
+ "description": "The max size of the response, defaults to 2000.",
1380
+ "type": "number"
1274
1381
  },
1275
- "_created_at": {
1276
- "type": "string",
1277
- "readOnly": true
1382
+ "hydrate": {
1383
+ "type": "boolean",
1384
+ "description": "When true, enables entity hydration to resolve nested $relation references in-place.",
1385
+ "default": false
1278
1386
  },
1279
- "_updated_at": {
1280
- "type": "string",
1281
- "readOnly": true
1387
+ "availability": {
1388
+ "$ref": "#/components/schemas/AvailabilityFilters"
1389
+ }
1390
+ },
1391
+ "example": {
1392
+ "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
1393
+ "sort": "description ASC",
1394
+ "from": 0,
1395
+ "size": 200,
1396
+ "availability": {
1397
+ "location": {
1398
+ "postal_code": "57008,",
1399
+ "city": "Cologne,",
1400
+ "street": "Media Park,",
1401
+ "street_number": "8a"
1402
+ },
1403
+ "available_date": {
1404
+ "value": "2022-05-01"
1405
+ }
1406
+ }
1407
+ },
1408
+ "required": [
1409
+ "q"
1410
+ ]
1411
+ },
1412
+ "CatalogSearchResult": {
1413
+ "description": "The query result payload",
1414
+ "type": "object",
1415
+ "properties": {
1416
+ "hits": {
1417
+ "type": "number",
1418
+ "description": "The number os results returned."
1282
1419
  },
1283
- "_tags": {
1420
+ "results": {
1284
1421
  "type": "array",
1285
1422
  "items": {
1286
- "type": "string"
1423
+ "anyOf": [
1424
+ {
1425
+ "$ref": "#/components/schemas/Product"
1426
+ },
1427
+ {
1428
+ "$ref": "#/components/schemas/Price"
1429
+ }
1430
+ ]
1287
1431
  }
1288
1432
  }
1289
- }
1290
- },
1291
- "PriceItems": {
1292
- "description": "Tracks a set of product prices, quantities, (discounts) and taxes.",
1293
- "type": "array",
1294
- "items": {
1295
- "oneOf": [
1433
+ },
1434
+ "example": {
1435
+ "hits": 2,
1436
+ "results": [
1296
1437
  {
1297
- "$ref": "#/components/schemas/PriceItem"
1438
+ "schema": "product",
1439
+ "description": "product a"
1440
+ },
1441
+ {
1442
+ "schema": "price",
1443
+ "unit_amount_decimal": "124.342343434"
1298
1444
  }
1299
1445
  ]
1300
1446
  }
1301
1447
  },
1302
- "PriceItem": {
1303
- "description": "Represents a price item",
1448
+ "AvailabilityCheckParams": {
1449
+ "description": "Availability check request payload",
1304
1450
  "type": "object",
1305
1451
  "properties": {
1306
- "id": {
1307
- "type": "string",
1308
- "description": "price item id",
1309
- "readOnly": true
1452
+ "products": {
1453
+ "description": "Products to check availability",
1454
+ "type": "array",
1455
+ "items": {
1456
+ "type": "string",
1457
+ "description": "Product under availability check"
1458
+ }
1459
+ },
1460
+ "filters": {
1461
+ "$ref": "#/components/schemas/AvailabilityFilters"
1462
+ }
1463
+ },
1464
+ "required": [
1465
+ "products",
1466
+ "filters"
1467
+ ]
1468
+ },
1469
+ "AvailabilityResult": {
1470
+ "description": "The availability check result payload",
1471
+ "type": "object",
1472
+ "properties": {
1473
+ "available_products": {
1474
+ "type": "array",
1475
+ "items": {
1476
+ "type": "string",
1477
+ "description": "Available Products"
1478
+ }
1310
1479
  },
1480
+ "check_results": {
1481
+ "description": "The check result details",
1482
+ "type": "array",
1483
+ "items": {
1484
+ "type": "object",
1485
+ "properties": {
1486
+ "product_id": {
1487
+ "type": "string"
1488
+ },
1489
+ "matching_hits": {
1490
+ "description": "The number of rules matched",
1491
+ "type": "number"
1492
+ },
1493
+ "matching_error": {
1494
+ "description": "A set of matching errors when checking availability",
1495
+ "type": "object",
1496
+ "additionalProperties": true
1497
+ }
1498
+ },
1499
+ "required": [
1500
+ "product_id"
1501
+ ]
1502
+ }
1503
+ }
1504
+ },
1505
+ "required": [
1506
+ "available_products"
1507
+ ],
1508
+ "example": {
1509
+ "available_products": [],
1510
+ "check_results": [
1511
+ {
1512
+ "product_id": "my-product-id-123-1",
1513
+ "matching_hits": 0
1514
+ },
1515
+ {
1516
+ "product_id": "my-product-id-123-2",
1517
+ "matching_hits": 0
1518
+ }
1519
+ ]
1520
+ }
1521
+ },
1522
+ "CartDto": {
1523
+ "description": "A valid cart payload from a client.",
1524
+ "properties": {
1311
1525
  "metadata": {
1312
1526
  "$ref": "#/components/schemas/MetaData"
1313
1527
  },
1314
- "unit_amount": {
1315
- "type": "integer",
1316
- "description": "The unit amount value",
1317
- "readOnly": true
1318
- },
1319
- "amount_subtotal": {
1320
- "type": "integer",
1321
- "description": "Total before any (discounts or) taxes are applied.",
1322
- "readOnly": true
1323
- },
1324
- "unit_amount_net": {
1325
- "type": "integer",
1326
- "description": "Net unit amount without taxes.",
1327
- "readOnly": true
1328
- },
1329
- "amount_total": {
1330
- "type": "integer",
1331
- "description": "Total after (discounts and) taxes.",
1332
- "readOnly": true
1333
- },
1334
- "currency": {
1335
- "$ref": "#/components/schemas/Currency"
1528
+ "customer": {
1529
+ "$ref": "#/components/schemas/Customer"
1336
1530
  },
1337
- "description": {
1338
- "type": "string",
1339
- "description": "An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."
1531
+ "billing_address": {
1532
+ "$ref": "#/components/schemas/Address"
1340
1533
  },
1341
- "quantity": {
1342
- "type": "integer",
1343
- "description": "The quantity of products being purchased."
1534
+ "delivery_address": {
1535
+ "$ref": "#/components/schemas/Address"
1344
1536
  },
1345
- "product_id": {
1537
+ "source_type": {
1346
1538
  "type": "string",
1347
- "description": "The id of the product."
1539
+ "description": "type of source, e.g. journey or manual",
1540
+ "example": "journey"
1348
1541
  },
1349
- "price_id": {
1542
+ "source_id": {
1350
1543
  "type": "string",
1351
- "description": "The id of the price."
1352
- },
1353
- "_price": {
1354
- "$ref": "#/components/schemas/Price"
1544
+ "description": "identifier for source e.g. journey ID",
1545
+ "example": "ce99875f-fba9-4fe2-a8f9-afaf52059051"
1355
1546
  },
1356
- "_product": {
1357
- "$ref": "#/components/schemas/Product"
1547
+ "source": {
1548
+ "$ref": "#/components/schemas/OrderSource"
1358
1549
  },
1359
- "taxes": {
1550
+ "additional_addresses": {
1360
1551
  "type": "array",
1361
- "description": "The taxes applied to the price item.",
1362
- "readOnly": true,
1363
1552
  "items": {
1364
- "oneOf": [
1365
- {
1366
- "$ref": "#/components/schemas/TaxAmount"
1367
- }
1368
- ]
1553
+ "$ref": "#/components/schemas/Address"
1369
1554
  }
1370
1555
  },
1371
- "recurrences": {
1556
+ "payment_method": {
1557
+ "$ref": "#/components/schemas/PaymentMethod"
1558
+ },
1559
+ "line_items": {
1560
+ "$ref": "#/components/schemas/PriceItemsDto"
1561
+ },
1562
+ "files": {
1372
1563
  "type": "array",
1373
- "description": "The sum of amounts of the price items by recurrence.",
1564
+ "description": "An array of file IDs, already upload into the File API, that are related with this cart",
1565
+ "items": {
1566
+ "type": "string",
1567
+ "description": "a string representing a file ID as received from the File API"
1568
+ }
1569
+ },
1570
+ "status": {
1571
+ "$ref": "#/components/schemas/OrderStatus"
1572
+ },
1573
+ "tags": {
1574
+ "type": "array",
1575
+ "items": {
1576
+ "type": "string"
1577
+ }
1578
+ },
1579
+ "journey_data": {
1580
+ "type": "object",
1581
+ "additionalProperties": true
1582
+ },
1583
+ "consents": {
1584
+ "type": "object",
1585
+ "additionalProperties": true
1586
+ }
1587
+ },
1588
+ "required": [
1589
+ "line_items"
1590
+ ]
1591
+ },
1592
+ "CheckoutCart": {
1593
+ "type": "object",
1594
+ "description": "The cart checkout request payload",
1595
+ "properties": {
1596
+ "cart": {
1597
+ "anyOf": [
1598
+ {
1599
+ "description": "the cart id",
1600
+ "type": "string"
1601
+ },
1602
+ {
1603
+ "$ref": "#/components/schemas/CartDto"
1604
+ }
1605
+ ]
1606
+ },
1607
+ "mode": {
1608
+ "$ref": "#/components/schemas/CheckoutMode"
1609
+ }
1610
+ }
1611
+ },
1612
+ "CheckoutCartResult": {
1613
+ "type": "object",
1614
+ "description": "The cart checkout result",
1615
+ "properties": {
1616
+ "order": {
1617
+ "$ref": "#/components/schemas/Order"
1618
+ }
1619
+ }
1620
+ },
1621
+ "CheckoutMode": {
1622
+ "type": "string",
1623
+ "description": "The checkout mode for the cart checkout.",
1624
+ "enum": [
1625
+ "create_order",
1626
+ "create_invoice",
1627
+ "create_quote"
1628
+ ]
1629
+ },
1630
+ "OrderStatus": {
1631
+ "type": "string",
1632
+ "enum": [
1633
+ "draft",
1634
+ "quote",
1635
+ "placed",
1636
+ "cancelled",
1637
+ "completed"
1638
+ ],
1639
+ "description": "\n| status | description |\n|-------------|-------|\n| `draft` | ​​Starting state for all orders, at this point we can still edit the order |\n| `quote` | The order is in a quoting phase, bound to an expiration date |\n| `placed` | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |\n| `cancelled` | The order has been cancelled |\n| `completed` | The order is now closed and finalized |\n"
1640
+ },
1641
+ "PriceItemsDto": {
1642
+ "description": "A valid set of product prices, quantities, (discounts) and taxes from a client.",
1643
+ "type": "array",
1644
+ "items": {
1645
+ "oneOf": [
1646
+ {
1647
+ "$ref": "#/components/schemas/PriceItemDto"
1648
+ }
1649
+ ]
1650
+ }
1651
+ },
1652
+ "PriceItemDto": {
1653
+ "description": "Represents a valid price item from a client.",
1654
+ "type": "object",
1655
+ "properties": {
1656
+ "metadata": {
1657
+ "$ref": "#/components/schemas/MetaData"
1658
+ },
1659
+ "quantity": {
1660
+ "type": "integer",
1661
+ "description": "The quantity of products being purchased."
1662
+ },
1663
+ "description": {
1664
+ "type": "string",
1665
+ "description": "An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."
1666
+ },
1667
+ "product_id": {
1668
+ "type": "string",
1669
+ "description": "The id of the product."
1670
+ },
1671
+ "price_id": {
1672
+ "type": "string",
1673
+ "description": "The id of the price."
1674
+ },
1675
+ "taxes": {
1676
+ "type": "array",
1677
+ "description": "The taxes applied to the price item.",
1374
1678
  "readOnly": true,
1375
1679
  "items": {
1376
1680
  "oneOf": [
1377
1681
  {
1378
- "$ref": "#/components/schemas/RecurrenceAmount"
1682
+ "$ref": "#/components/schemas/TaxAmountDto"
1683
+ }
1684
+ ]
1685
+ }
1686
+ },
1687
+ "recurrences": {
1688
+ "type": "array",
1689
+ "description": "The taxes applied to the price item.",
1690
+ "readOnly": true,
1691
+ "items": {
1692
+ "oneOf": [
1693
+ {
1694
+ "$ref": "#/components/schemas/RecurrenceAmountDto"
1379
1695
  }
1380
1696
  ]
1381
1697
  }
1698
+ },
1699
+ "_price": {
1700
+ "$ref": "#/components/schemas/Price"
1701
+ },
1702
+ "_product": {
1703
+ "description": "The product linked to the price item.",
1704
+ "$ref": "#/components/schemas/Product"
1382
1705
  }
1383
1706
  }
1384
1707
  },
1385
- "TaxAmount": {
1708
+ "TaxAmountDto": {
1386
1709
  "type": "object",
1387
- "description": "A tax amount associated with a specific tax rate.",
1388
- "readOnly": true,
1710
+ "description": "A valid tax rate from a client.",
1389
1711
  "properties": {
1390
- "amount": {
1391
- "type": "integer",
1392
- "description": "The tax amount."
1393
- },
1394
1712
  "rate": {
1395
1713
  "type": "string",
1396
1714
  "description": "The tax rate applied."
@@ -1405,10 +1723,41 @@
1405
1723
  }
1406
1724
  }
1407
1725
  },
1408
- "RecurrenceAmount": {
1726
+ "OrderSource": {
1727
+ "type": "object",
1728
+ "description": "The order generation source",
1729
+ "properties": {
1730
+ "http": {
1731
+ "type": "string",
1732
+ "description": "Link path for the source",
1733
+ "example": "/app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939"
1734
+ },
1735
+ "title": {
1736
+ "type": "string",
1737
+ "description": "Title for the source",
1738
+ "example": "Journey: PH Journey"
1739
+ }
1740
+ }
1741
+ },
1742
+ "OpportunitySource": {
1743
+ "type": "object",
1744
+ "description": "The opportunity generation source",
1745
+ "properties": {
1746
+ "http": {
1747
+ "type": "string",
1748
+ "description": "Link path for the source",
1749
+ "example": "/app/v2/journey-builder/editor/db7f6940-994b-11ec-a46d-9f1824ff2939"
1750
+ },
1751
+ "title": {
1752
+ "type": "string",
1753
+ "description": "Title for the source",
1754
+ "example": "Journey: PH Journey"
1755
+ }
1756
+ }
1757
+ },
1758
+ "RecurrenceAmountDto": {
1409
1759
  "type": "object",
1410
1760
  "description": "An amount associated with a specific recurrence.",
1411
- "readOnly": true,
1412
1761
  "properties": {
1413
1762
  "type": {
1414
1763
  "type": "string",
@@ -1437,220 +1786,436 @@
1437
1786
  "amount_total"
1438
1787
  ]
1439
1788
  },
1440
- "TotalDetails": {
1441
- "type": "object",
1442
- "description": "The total details with tax (and discount) aggregated totals.",
1443
- "readOnly": true,
1789
+ "Cart": {
1790
+ "description": "Supports shopping for products and services until ready for checkout.",
1444
1791
  "properties": {
1445
- "amount_shipping": {
1792
+ "id": {
1793
+ "type": "string",
1794
+ "description": "The cart identifier"
1795
+ },
1796
+ "org_id": {
1797
+ "type": "string",
1798
+ "description": "The user's Organization Id the cart belongs to",
1799
+ "readOnly": true
1800
+ },
1801
+ "status": {
1802
+ "enum": [
1803
+ "open",
1804
+ "complete",
1805
+ "expired"
1806
+ ],
1807
+ "type": "string",
1808
+ "readOnly": true,
1809
+ "description": "The status of the Cart:\n- open - the cart checkout is still in progress. Payment processing has not started\n- complete - the cart checkout is complete. Payment processing may still be in progress\n- expired - the cart checkout has expired. No further processing will occur\n"
1810
+ },
1811
+ "customer": {
1812
+ "$ref": "#/components/schemas/Customer"
1813
+ },
1814
+ "billing_address": {
1815
+ "$ref": "#/components/schemas/Address"
1816
+ },
1817
+ "delivery_address": {
1818
+ "$ref": "#/components/schemas/Address"
1819
+ },
1820
+ "metadata": {
1821
+ "$ref": "#/components/schemas/MetaData"
1822
+ },
1823
+ "line_items": {
1824
+ "$ref": "#/components/schemas/PriceItems"
1825
+ },
1826
+ "amount_subtotal": {
1827
+ "readOnly": true,
1446
1828
  "type": "integer",
1447
- "description": "This is the sum of all the price item shipping amounts."
1829
+ "description": "Total of all items before (discounts or) taxes are applied."
1448
1830
  },
1449
- "amount_tax": {
1831
+ "amount_total": {
1832
+ "readOnly": true,
1450
1833
  "type": "integer",
1451
- "description": "This is the sum of all the price item tax amounts."
1834
+ "description": "Total of all items after (discounts and) taxes are applied."
1452
1835
  },
1453
- "breakdown": {
1454
- "type": "object",
1455
- "description": "Breakdown of individual tax (and discount) amounts that add up to the totals.",
1456
- "properties": {
1457
- "taxes": {
1458
- "type": "array",
1459
- "description": "The aggregated price items tax amount per rate.",
1460
- "items": {
1461
- "oneOf": [
1462
- {
1463
- "$ref": "#/components/schemas/TaxAmount"
1464
- }
1465
- ]
1466
- }
1467
- },
1468
- "recurrences": {
1469
- "type": "array",
1470
- "description": "The aggregated price items tax amount per rate.",
1471
- "items": {
1472
- "oneOf": [
1473
- {
1474
- "$ref": "#/components/schemas/RecurrenceAmount"
1475
- }
1476
- ]
1477
- }
1478
- }
1479
- }
1836
+ "total_details": {
1837
+ "$ref": "#/components/schemas/TotalDetails"
1838
+ },
1839
+ "created_at": {
1840
+ "readOnly": true,
1841
+ "type": "string",
1842
+ "format": "date-time"
1843
+ },
1844
+ "updated_at": {
1845
+ "readOnly": true,
1846
+ "type": "string",
1847
+ "format": "date-time"
1480
1848
  }
1481
1849
  }
1482
1850
  },
1483
- "PricingDetails": {
1851
+ "Currency": {
1852
+ "type": "string",
1853
+ "description": "Three-letter ISO currency code, in lowercase. Must be a supported currency.\nISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html\n",
1854
+ "example": "EUR"
1855
+ },
1856
+ "OrderRelation": {
1484
1857
  "type": "object",
1485
- "description": "The result from the calculation of a set of price items.",
1858
+ "description": "An order relation reference",
1486
1859
  "properties": {
1487
- "items": {
1860
+ "entity_id": {
1861
+ "type": "string",
1862
+ "description": "The relation order id"
1863
+ },
1864
+ "_tags": {
1488
1865
  "type": "array",
1489
1866
  "items": {
1490
- "oneOf": [
1491
- {
1492
- "$ref": "#/components/schemas/PriceItem"
1493
- }
1494
- ]
1867
+ "type": "string",
1868
+ "description": "The tags array associated with the relation"
1495
1869
  }
1496
- },
1497
- "amount_subtotal": {
1498
- "type": "integer",
1499
- "description": "Total of all items before (discounts or) taxes are applied."
1500
- },
1501
- "amount_total": {
1502
- "type": "integer",
1503
- "description": "Total of all items after (discounts and) taxes are applied."
1504
- },
1505
- "total_details": {
1506
- "$ref": "#/components/schemas/TotalDetails"
1507
1870
  }
1508
1871
  }
1509
1872
  },
1510
- "BillingPeriod": {
1511
- "type": "string",
1512
- "enum": [
1513
- "weekly",
1514
- "monthly",
1515
- "every_quarter",
1516
- "every_6_months",
1517
- "yearly",
1518
- "one_time"
1519
- ]
1520
- },
1521
- "SalesTax": {
1522
- "type": "string",
1523
- "enum": [
1524
- "nontaxable",
1525
- "reduced",
1526
- "standard"
1527
- ]
1528
- },
1529
- "Price": {
1873
+ "OrderPayload": {
1530
1874
  "type": "object",
1531
- "description": "The price configuration",
1532
- "additionalProperties": true,
1533
- "readOnly": true,
1875
+ "description": "Order Entity Payload",
1534
1876
  "properties": {
1535
- "active": {
1536
- "type": "boolean"
1877
+ "status": {
1878
+ "$ref": "#/components/schemas/OrderStatus"
1537
1879
  },
1538
- "billing_scheme": {
1539
- "type": "string",
1540
- "enum": [
1541
- "Per Unit"
1542
- ]
1880
+ "line_items": {
1881
+ "$ref": "#/components/schemas/PriceItems"
1543
1882
  },
1544
- "description": {
1545
- "type": "string"
1883
+ "source_type": {
1884
+ "type": "string",
1885
+ "description": "type of source, e.g. journey or manual",
1886
+ "example": "journey"
1546
1887
  },
1547
- "sales_tax": {
1548
- "$ref": "#/components/schemas/SalesTax"
1888
+ "currency": {
1889
+ "$ref": "#/components/schemas/Currency"
1549
1890
  },
1550
- "tax_behavior": {
1891
+ "contact": {
1892
+ "readOnly": true,
1551
1893
  "type": "string",
1552
- "enum": [
1553
- "inclusive",
1554
- "exclusive"
1555
- ]
1894
+ "description": "The id of an existing contact."
1556
1895
  },
1557
- "tiers_mode": {
1558
- "type": "string",
1559
- "enum": [
1560
- "Standard"
1561
- ]
1896
+ "billing_first_name": {
1897
+ "type": "string"
1562
1898
  },
1563
- "type": {
1564
- "type": "string",
1565
- "enum": [
1566
- "one_time",
1567
- "recurring"
1568
- ]
1899
+ "billing_last_name": {
1900
+ "type": "string"
1569
1901
  },
1570
- "billing_period": {
1571
- "$ref": "#/components/schemas/BillingPeriod"
1902
+ "billing_company_name": {
1903
+ "type": "string"
1572
1904
  },
1573
- "unit_amount": {
1574
- "type": "number"
1905
+ "billing_vat": {
1906
+ "type": "string"
1575
1907
  },
1576
- "unit_amount_decimal": {
1908
+ "billing_email": {
1577
1909
  "type": "string"
1578
1910
  },
1579
- "unit_amount_currency": {
1580
- "$ref": "#/components/schemas/Currency"
1911
+ "billing_phone": {
1912
+ "type": "string"
1581
1913
  },
1582
- "billing_duration_amount": {
1583
- "type": "number"
1914
+ "billing_address": {
1915
+ "type": "array",
1916
+ "items": {
1917
+ "$ref": "#/components/schemas/Address"
1918
+ }
1584
1919
  },
1585
- "billing_duration_unit": {
1586
- "type": "string",
1587
- "enum": [
1588
- "weeks",
1589
- "months",
1590
- "years"
1591
- ]
1920
+ "delivery_address": {
1921
+ "type": "array",
1922
+ "items": {
1923
+ "$ref": "#/components/schemas/Address"
1924
+ }
1592
1925
  },
1593
- "notice_time_amount": {
1594
- "type": "number"
1926
+ "payment_method": {
1927
+ "type": "array",
1928
+ "items": {
1929
+ "$ref": "#/components/schemas/PaymentMethod"
1930
+ }
1595
1931
  },
1596
- "notice_time_unit": {
1932
+ "_tags": {
1933
+ "type": "array",
1934
+ "items": {
1935
+ "type": "string"
1936
+ }
1937
+ }
1938
+ }
1939
+ },
1940
+ "PriceItems": {
1941
+ "description": "Tracks a set of product prices, quantities, (discounts) and taxes.",
1942
+ "type": "array",
1943
+ "items": {
1944
+ "oneOf": [
1945
+ {
1946
+ "$ref": "#/components/schemas/PriceItem"
1947
+ }
1948
+ ]
1949
+ }
1950
+ },
1951
+ "PriceItem": {
1952
+ "description": "Represents a price item",
1953
+ "type": "object",
1954
+ "example": {
1955
+ "$ref": "#/components/examples/order-with-simple-prices"
1956
+ },
1957
+ "properties": {
1958
+ "id": {
1597
1959
  "type": "string",
1598
- "enum": [
1599
- "weeks",
1600
- "months",
1601
- "years"
1602
- ]
1960
+ "description": "price item id",
1961
+ "readOnly": true
1603
1962
  },
1604
- "termination_time_amount": {
1605
- "type": "number"
1963
+ "metadata": {
1964
+ "$ref": "#/components/schemas/MetaData"
1606
1965
  },
1607
- "termination_time_unit": {
1608
- "type": "string",
1609
- "enum": [
1610
- "weeks",
1611
- "months",
1612
- "years"
1613
- ]
1966
+ "item_components": {
1967
+ "type": "array",
1968
+ "description": "Contains price item configurations, per price component, when the main price item is a [price bundle](/api/pricing#tag/dynamic_price_schema).",
1969
+ "items": {
1970
+ "$ref": "#/components/schemas/PriceItemComponent"
1971
+ }
1614
1972
  },
1615
- "renewal_duration_amount": {
1616
- "type": "number"
1973
+ "unit_amount": {
1974
+ "type": "integer",
1975
+ "description": "The unit amount value",
1976
+ "readOnly": true
1617
1977
  },
1618
- "renewal_duration_unit": {
1619
- "type": "string",
1620
- "enum": [
1621
- "weeks",
1622
- "months",
1623
- "years"
1624
- ]
1978
+ "amount_subtotal": {
1979
+ "type": "integer",
1980
+ "description": "Total before any (discounts or) taxes are applied.",
1981
+ "readOnly": true
1625
1982
  },
1626
- "_created_at": {
1627
- "type": "string"
1983
+ "unit_amount_net": {
1984
+ "type": "integer",
1985
+ "description": "Net unit amount without taxes or discounts.",
1986
+ "readOnly": true
1628
1987
  },
1629
- "_id": {
1630
- "type": "string"
1988
+ "amount_total": {
1989
+ "type": "integer",
1990
+ "description": "Total after (discounts and) taxes.",
1991
+ "readOnly": true
1631
1992
  },
1632
- "_title": {
1633
- "type": "string"
1993
+ "currency": {
1994
+ "$ref": "#/components/schemas/Currency"
1634
1995
  },
1635
- "_updated_at": {
1636
- "type": "string"
1637
- }
1638
- }
1639
- },
1640
- "AvailabilityLocation": {
1641
- "type": "object",
1642
- "properties": {
1643
- "street": {
1996
+ "description": {
1644
1997
  "type": "string",
1645
- "description": "The first line of the address. Typically the street address or PO Box number."
1998
+ "description": "An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."
1646
1999
  },
1647
- "street_number": {
1648
- "type": "string",
1649
- "description": "The second line of the address. Typically the number of the apartment, suite, or unit."
2000
+ "quantity": {
2001
+ "type": "integer",
2002
+ "description": "The quantity of products being purchased."
1650
2003
  },
1651
- "postal_code": {
2004
+ "product_id": {
1652
2005
  "type": "string",
1653
- "description": "The postal code for the address."
2006
+ "description": "The id of the product."
2007
+ },
2008
+ "price_id": {
2009
+ "type": "string",
2010
+ "description": "The id of the price."
2011
+ },
2012
+ "_price": {
2013
+ "description": "The price snapshot data.",
2014
+ "anyOf": [
2015
+ {
2016
+ "$ref": "#/components/schemas/Price"
2017
+ }
2018
+ ]
2019
+ },
2020
+ "_product": {
2021
+ "description": "The product snapshot data.",
2022
+ "anyOf": [
2023
+ {
2024
+ "$ref": "#/components/schemas/Product"
2025
+ }
2026
+ ]
2027
+ },
2028
+ "taxes": {
2029
+ "type": "array",
2030
+ "description": "The taxes applied to the price item.",
2031
+ "readOnly": true,
2032
+ "items": {
2033
+ "oneOf": [
2034
+ {
2035
+ "$ref": "#/components/schemas/TaxAmount"
2036
+ }
2037
+ ]
2038
+ }
2039
+ },
2040
+ "recurrences": {
2041
+ "type": "array",
2042
+ "description": "The sum of amounts of the price items by recurrence.",
2043
+ "readOnly": true,
2044
+ "items": {
2045
+ "oneOf": [
2046
+ {
2047
+ "$ref": "#/components/schemas/RecurrenceAmount"
2048
+ }
2049
+ ]
2050
+ }
2051
+ }
2052
+ }
2053
+ },
2054
+ "PriceItemComponent": {
2055
+ "oneOf": [
2056
+ {
2057
+ "$ref": "#/components/schemas/PriceItem"
2058
+ }
2059
+ ]
2060
+ },
2061
+ "TaxAmount": {
2062
+ "type": "object",
2063
+ "description": "A tax amount associated with a specific tax rate.",
2064
+ "readOnly": true,
2065
+ "properties": {
2066
+ "amount": {
2067
+ "type": "integer",
2068
+ "description": "The tax amount."
2069
+ },
2070
+ "rate": {
2071
+ "type": "string",
2072
+ "description": "The tax rate applied."
2073
+ },
2074
+ "tax": {
2075
+ "description": "The tax applied.",
2076
+ "oneOf": [
2077
+ {
2078
+ "$ref": "#/components/schemas/Tax"
2079
+ }
2080
+ ]
2081
+ }
2082
+ }
2083
+ },
2084
+ "RecurrenceAmount": {
2085
+ "type": "object",
2086
+ "description": "An amount associated with a specific recurrence.",
2087
+ "readOnly": true,
2088
+ "properties": {
2089
+ "type": {
2090
+ "type": "string",
2091
+ "description": "The price type."
2092
+ },
2093
+ "billing_period": {
2094
+ "type": "string",
2095
+ "description": "The price billing period."
2096
+ },
2097
+ "amount_subtotal": {
2098
+ "type": "integer",
2099
+ "description": "Total of all items, with same recurrence, before (discounts or) taxes are applied."
2100
+ },
2101
+ "amount_total": {
2102
+ "type": "integer",
2103
+ "description": "Total of all items, with same recurrence, after (discounts and) taxes are applied."
2104
+ },
2105
+ "amount_tax": {
2106
+ "type": "integer",
2107
+ "description": "Total of all items taxes, with same recurrence."
2108
+ }
2109
+ },
2110
+ "required": [
2111
+ "type",
2112
+ "amount_subtotal",
2113
+ "amount_total"
2114
+ ]
2115
+ },
2116
+ "TotalDetails": {
2117
+ "type": "object",
2118
+ "description": "The total details with tax (and discount) aggregated totals.",
2119
+ "readOnly": true,
2120
+ "properties": {
2121
+ "amount_shipping": {
2122
+ "type": "integer",
2123
+ "description": "This is the sum of all the price item shipping amounts."
2124
+ },
2125
+ "amount_tax": {
2126
+ "type": "integer",
2127
+ "description": "This is the sum of all the price item tax amounts."
2128
+ },
2129
+ "breakdown": {
2130
+ "type": "object",
2131
+ "description": "Breakdown of individual tax (and discount) amounts that add up to the totals.",
2132
+ "properties": {
2133
+ "taxes": {
2134
+ "type": "array",
2135
+ "description": "The aggregated price items tax amount per rate.",
2136
+ "items": {
2137
+ "oneOf": [
2138
+ {
2139
+ "$ref": "#/components/schemas/TaxAmount"
2140
+ }
2141
+ ]
2142
+ }
2143
+ },
2144
+ "recurrences": {
2145
+ "type": "array",
2146
+ "description": "The aggregated price items tax amount per rate.",
2147
+ "items": {
2148
+ "oneOf": [
2149
+ {
2150
+ "$ref": "#/components/schemas/RecurrenceAmount"
2151
+ }
2152
+ ]
2153
+ }
2154
+ }
2155
+ }
2156
+ }
2157
+ }
2158
+ },
2159
+ "PricingDetails": {
2160
+ "type": "object",
2161
+ "description": "The result from the calculation of a set of price items.",
2162
+ "properties": {
2163
+ "items": {
2164
+ "type": "array",
2165
+ "items": {
2166
+ "oneOf": [
2167
+ {
2168
+ "$ref": "#/components/schemas/PriceItem"
2169
+ }
2170
+ ]
2171
+ }
2172
+ },
2173
+ "amount_subtotal": {
2174
+ "type": "integer",
2175
+ "description": "Total of all items before (discounts or) taxes are applied."
2176
+ },
2177
+ "amount_total": {
2178
+ "type": "integer",
2179
+ "description": "Total of all items after (discounts and) taxes are applied."
2180
+ },
2181
+ "total_details": {
2182
+ "$ref": "#/components/schemas/TotalDetails"
2183
+ }
2184
+ }
2185
+ },
2186
+ "BillingPeriod": {
2187
+ "type": "string",
2188
+ "enum": [
2189
+ "weekly",
2190
+ "monthly",
2191
+ "every_quarter",
2192
+ "every_6_months",
2193
+ "yearly",
2194
+ "one_time"
2195
+ ]
2196
+ },
2197
+ "SalesTax": {
2198
+ "type": "string",
2199
+ "enum": [
2200
+ "nontaxable",
2201
+ "reduced",
2202
+ "standard"
2203
+ ]
2204
+ },
2205
+ "AvailabilityLocation": {
2206
+ "type": "object",
2207
+ "properties": {
2208
+ "street": {
2209
+ "type": "string",
2210
+ "description": "The first line of the address. Typically the street address or PO Box number."
2211
+ },
2212
+ "street_number": {
2213
+ "type": "string",
2214
+ "description": "The second line of the address. Typically the number of the apartment, suite, or unit."
2215
+ },
2216
+ "postal_code": {
2217
+ "type": "string",
2218
+ "description": "The postal code for the address."
1654
2219
  },
1655
2220
  "city": {
1656
2221
  "type": "string",
@@ -1733,6 +2298,26 @@
1733
2298
  "additional_info": {
1734
2299
  "type": "string",
1735
2300
  "description": "An additional description for the address"
2301
+ },
2302
+ "company_name": {
2303
+ "type": "string",
2304
+ "description": "the company name, usually used as extra delivery instructions"
2305
+ },
2306
+ "first_name": {
2307
+ "type": "string",
2308
+ "description": "the first name of the recipient, usually used as extra delivery instructions"
2309
+ },
2310
+ "last_name": {
2311
+ "type": "string",
2312
+ "description": "the last name of the recipient, usually used as extra delivery instructions"
2313
+ },
2314
+ "salutation": {
2315
+ "type": "string",
2316
+ "description": "the salutation of the recipient, usually used as extra delivery instructions"
2317
+ },
2318
+ "title": {
2319
+ "type": "string",
2320
+ "description": "the title of the recipient, usually used as extra delivery instructions"
1736
2321
  }
1737
2322
  }
1738
2323
  },
@@ -1775,39 +2360,6 @@
1775
2360
  }
1776
2361
  }
1777
2362
  },
1778
- "Product": {
1779
- "type": "object",
1780
- "description": "The product configuration",
1781
- "readOnly": true,
1782
- "additionalProperties": true,
1783
- "properties": {
1784
- "code": {
1785
- "type": "string"
1786
- },
1787
- "type": {
1788
- "type": "string",
1789
- "enum": [
1790
- "Product",
1791
- "Service"
1792
- ]
1793
- },
1794
- "name": {
1795
- "type": "string"
1796
- },
1797
- "_id": {
1798
- "type": "string"
1799
- },
1800
- "_title": {
1801
- "type": "string"
1802
- },
1803
- "_availability_files": {
1804
- "type": "array",
1805
- "items": {
1806
- "$ref": "#/components/schemas/File"
1807
- }
1808
- }
1809
- }
1810
- },
1811
2363
  "File": {
1812
2364
  "type": "object",
1813
2365
  "additionalProperties": true,
@@ -1895,236 +2447,1430 @@
1895
2447
  }
1896
2448
  }
1897
2449
  },
1898
- "Tax": {
1899
- "type": "object",
1900
- "description": "the tax configuration",
1901
- "additionalProperties": true,
1902
- "required": [
1903
- "type",
1904
- "rate",
1905
- "behavior"
1906
- ],
1907
- "properties": {
1908
- "type": {
1909
- "type": "string",
1910
- "enum": [
1911
- "VAT",
1912
- "GST",
1913
- "Custom"
2450
+ "Tax": {
2451
+ "type": "object",
2452
+ "description": "the tax configuration",
2453
+ "additionalProperties": true,
2454
+ "required": [
2455
+ "type",
2456
+ "rate",
2457
+ "behavior"
2458
+ ],
2459
+ "properties": {
2460
+ "type": {
2461
+ "type": "string",
2462
+ "enum": [
2463
+ "VAT",
2464
+ "GST",
2465
+ "Custom"
2466
+ ]
2467
+ },
2468
+ "description": {
2469
+ "type": "string"
2470
+ },
2471
+ "rate": {
2472
+ "type": "number"
2473
+ },
2474
+ "behavior": {
2475
+ "type": "string",
2476
+ "enum": [
2477
+ "Exclusive",
2478
+ "Inclusive"
2479
+ ]
2480
+ },
2481
+ "active": {
2482
+ "type": "boolean"
2483
+ },
2484
+ "region": {
2485
+ "type": "string"
2486
+ },
2487
+ "region_label": {
2488
+ "type": "string"
2489
+ }
2490
+ }
2491
+ }
2492
+ },
2493
+ "examples": {
2494
+ "checkout-with-cart-id": {
2495
+ "value": {
2496
+ "mode": "create_order",
2497
+ "cart": "pZ324jnndf"
2498
+ }
2499
+ },
2500
+ "checkout-with-transient-cart": {
2501
+ "value": {
2502
+ "mode": "create_order",
2503
+ "cart": {
2504
+ "metadata": [
2505
+ {
2506
+ "key": "journey-id",
2507
+ "value": "8d0a2235-97ce-42d0-88a3-e374634ca44e"
2508
+ }
2509
+ ],
2510
+ "customer": {
2511
+ "first_name": "john",
2512
+ "last_name": "doe",
2513
+ "company_name": "company limited",
2514
+ "vat_id": "123892321",
2515
+ "email": "johndoe@company.com",
2516
+ "phone": "+44233242423"
2517
+ },
2518
+ "billing_address": {
2519
+ "street1": "wallstreet",
2520
+ "street2": 1,
2521
+ "city": "new york city",
2522
+ "country": "united states",
2523
+ "country_code": "US",
2524
+ "additional_info": "headquarters office"
2525
+ },
2526
+ "delivery_address": {
2527
+ "street1": "berverly hills avenue",
2528
+ "street2": "block 1",
2529
+ "city": "berverly hills",
2530
+ "country": "california",
2531
+ "country_code": "CA",
2532
+ "additional_info": "remote cowork place"
2533
+ },
2534
+ "line_items": [
2535
+ {
2536
+ "quantity": 1,
2537
+ "product": "b7185fb7-b10f-4875-bda7-288631446555",
2538
+ "price": "df240bab-9f71-4a9a-a9e1-59f18827dbf9"
2539
+ },
2540
+ {
2541
+ "quantity": 1,
2542
+ "product": "zzzzzz-b10f-4875-bda7-288631446555",
2543
+ "price": "zzzzz-9f71-4a9a-a9e1-59f18827dbf9"
2544
+ }
2545
+ ],
2546
+ "files": [
2547
+ "xf240bab-9f71-4a9a-a9e1-59f18827dbf9",
2548
+ "yf240bab-9f71-4a9a-a9e1-59f18827dbf9",
2549
+ "zf240bab-9f71-4a9a-a9e1-59f18827dbf9"
2550
+ ]
2551
+ }
2552
+ }
2553
+ },
2554
+ "checkout-result": {
2555
+ "value": {
2556
+ "order": {
2557
+ "_id": "d1ZoC1FwZ6",
2558
+ "type": "Draft",
2559
+ "cart_id": "p0ZoB1FwH6",
2560
+ "order_number": "20201021-234324",
2561
+ "_org_id": 123,
2562
+ "metadata": [
2563
+ {
2564
+ "key": "journey-id",
2565
+ "value": "8d0a2235-97ce-42d0-88a3-e374634ca44e"
2566
+ }
2567
+ ],
2568
+ "billing_first_name": "john",
2569
+ "billing_last_name": "doe",
2570
+ "billing_company_name": "i me and myself",
2571
+ "billing_vat": "234823948",
2572
+ "billing_email": "johndoe@nowhere.com",
2573
+ "currency": "EUR",
2574
+ "billing_phone": "+1234234545",
2575
+ "billing_address": "wallstreet, 1",
2576
+ "billing_contact": "villy or zilly",
2577
+ "line_items": [
2578
+ {
2579
+ "id": "mSjGCTfn8w",
2580
+ "metadata": [
2581
+ {
2582
+ "cart_id": "p0ZoB1FwH6"
2583
+ }
2584
+ ],
2585
+ "description": "Wallbox Premium - Premium Price",
2586
+ "currency": "EUR",
2587
+ "unit_amount": 78900,
2588
+ "amount_subtotal": 50000,
2589
+ "amount_total": 61500,
2590
+ "quantity": 1,
2591
+ "product_id": "b7185fb7-b10f-4875-bda7-288631446555",
2592
+ "price_id": "df240bab-9f71-4a9a-a9e1-59f18827dbf9",
2593
+ "taxes": [
2594
+ {
2595
+ "amount": 11500,
2596
+ "rate": "MwSt. 23%"
2597
+ }
2598
+ ],
2599
+ "_price": {
2600
+ "_id": "df240bab-9f71-4a9a-a9e1-59f18827dbf9",
2601
+ "unit_amount": "€ 789",
2602
+ "type": "one_time",
2603
+ "active": true,
2604
+ "sales_tax": "standard",
2605
+ "tax_behavior": "inclusive",
2606
+ "description": "Winter Sale",
2607
+ "billing_scheme": "per_unit",
2608
+ "tiers_mode": "Standard",
2609
+ "_created_at": "2021-11-10T18:02:58.318Z",
2610
+ "_updated_at": "2021-11-10T18:02:58.318Z",
2611
+ "_title": "Winter Sale"
2612
+ }
2613
+ },
2614
+ {
2615
+ "id": "mZkGCTfn6p",
2616
+ "metadata": [
2617
+ {
2618
+ "cart_id": "p0ZoB1FwH6"
2619
+ }
2620
+ ],
2621
+ "description": "Wallbox Basic with Full Add-ons - Basic Price",
2622
+ "currency": "EUR",
2623
+ "unit_amount": 78900,
2624
+ "amount_subtotal": 50000,
2625
+ "amount_total": 53500,
2626
+ "quantity": 1,
2627
+ "product_id": "zzzzzz-b10f-4875-bda7-288631446555",
2628
+ "price_id": "zzzzz-9f71-4a9a-a9e1-59f18827dbf9",
2629
+ "taxes": [
2630
+ {
2631
+ "amount": 3500,
2632
+ "rate": "MwSt. 7%"
2633
+ }
2634
+ ],
2635
+ "_price": {
2636
+ "_id": "zzzzz-9f71-4a9a-a9e1-59f18827dbf9",
2637
+ "unit_amount": "€ 789",
2638
+ "type": "one_time",
2639
+ "active": true,
2640
+ "sales_tax": "standard",
2641
+ "tax_behavior": "inclusive",
2642
+ "description": "Winter Sale",
2643
+ "billing_scheme": "per_unit",
2644
+ "tiers_mode": "Standard",
2645
+ "_created_at": "2021-11-10T18:02:58.318Z",
2646
+ "_updated_at": "2021-11-10T18:02:58.318Z",
2647
+ "_title": "Winter Sale"
2648
+ }
2649
+ }
2650
+ ],
2651
+ "amount_subtotal": 100000,
2652
+ "amount_total": 115000,
2653
+ "total_details": {
2654
+ "amount_shipping": 10000,
2655
+ "amount_tax": 15000,
2656
+ "breakdown": [
2657
+ {
2658
+ "amount": 11500,
2659
+ "rate": "MwSt. 23%"
2660
+ },
2661
+ {
2662
+ "amount": 3500,
2663
+ "rate": "MwSt. 7%"
2664
+ }
2665
+ ]
2666
+ },
2667
+ "_created_at": "2021-11-10T18:02:58.318Z",
2668
+ "_updated_at": "2021-11-10T18:02:58.318Z"
2669
+ }
2670
+ }
2671
+ },
2672
+ "order-with-simple-prices": {
2673
+ "value": {
2674
+ "order_number": "OR 2022/742701",
2675
+ "status": "quote",
2676
+ "source": {
2677
+ "title": "manual",
2678
+ "href": null
2679
+ },
2680
+ "source_type": "manual",
2681
+ "_schema": "order",
2682
+ "_title": "OR 2022/742701",
2683
+ "expires_at": "2022-06-30T16:17:00.000Z",
2684
+ "line_items": [
2685
+ {
2686
+ "price_id": "9c36c23b-1574-4193-beff-b1b5e1124bc7",
2687
+ "product_id": "a7f4771a-6368-4d77-bb01-71f1e4902de5",
2688
+ "taxes": [
2689
+ {
2690
+ "tax": {
2691
+ "_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc",
2692
+ "rate": "19",
2693
+ "behavior": "Inclusive",
2694
+ "_schema": "tax",
2695
+ "_org": "728",
2696
+ "_created_at": "2021-09-24T15:06:13.859Z",
2697
+ "_updated_at": "2022-04-04T17:36:15.273Z",
2698
+ "_title": "Tax Standard",
2699
+ "type": "VAT",
2700
+ "active": true,
2701
+ "region": "DE",
2702
+ "description": "Standard"
2703
+ },
2704
+ "amount": 255462
2705
+ }
2706
+ ],
2707
+ "_price": {
2708
+ "_id": "9c36c23b-1574-4193-beff-b1b5e1124bc7",
2709
+ "unit_amount": 100000,
2710
+ "unit_amount_currency": "EUR",
2711
+ "unit_amount_decimal": "1000",
2712
+ "sales_tax": "standard",
2713
+ "tax_behavior": "inclusive",
2714
+ "price_display_in_journeys": "show_price",
2715
+ "type": "one_time",
2716
+ "billing_period": "weekly",
2717
+ "billing_duration_unit": "months",
2718
+ "notice_time_unit": "months",
2719
+ "termination_time_unit": "months",
2720
+ "renewal_duration_unit": "months",
2721
+ "_schema": "price",
2722
+ "_title": "Solar Panel Module",
2723
+ "description": "Solar Panel Module",
2724
+ "active": true,
2725
+ "tax": {
2726
+ "$relation": [
2727
+ {
2728
+ "entity_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc"
2729
+ }
2730
+ ]
2731
+ },
2732
+ "_org": "728",
2733
+ "_created_at": "2022-06-03T16:04:10.369Z",
2734
+ "_updated_at": "2022-06-03T16:04:10.369Z"
2735
+ },
2736
+ "_product": {
2737
+ "_id": "a7f4771a-6368-4d77-bb01-71f1e4902de5",
2738
+ "type": "product",
2739
+ "_schema": "product",
2740
+ "_title": "Solar Panel with Battery Storage",
2741
+ "name": "Solar Panel with Battery Storage",
2742
+ "code": "SOLAR-BATT",
2743
+ "active": true,
2744
+ "description": "Solar Panel with battery solution, optimized for max efficiency. ",
2745
+ "feature": [
2746
+ {
2747
+ "_tags": [],
2748
+ "feature": "Eco-Panels"
2749
+ },
2750
+ {
2751
+ "_tags": [],
2752
+ "feature": "Remote Management Platform"
2753
+ },
2754
+ {
2755
+ "_tags": [],
2756
+ "feature": "Battery Remote Control"
2757
+ },
2758
+ {
2759
+ "_tags": [],
2760
+ "feature": "Mobile App"
2761
+ }
2762
+ ],
2763
+ "cross_sellable_products": {
2764
+ "$relation": [
2765
+ {
2766
+ "entity_id": "068d0713-a650-4668-9ed2-eca7be31e337",
2767
+ "_schema": "product",
2768
+ "_tags": []
2769
+ },
2770
+ {
2771
+ "entity_id": "c8402ee7-fba9-4f3d-bffd-6803ca655782",
2772
+ "_tags": []
2773
+ }
2774
+ ]
2775
+ },
2776
+ "product_images": {
2777
+ "$relation": [
2778
+ {
2779
+ "entity_id": "37bdeaaa-65fe-403e-9894-65b01cd277f1"
2780
+ },
2781
+ {
2782
+ "entity_id": "56dde657-795c-41bb-bf53-98fd586b7e6e"
2783
+ }
2784
+ ]
2785
+ },
2786
+ "product_downloads": {
2787
+ "$relation": [
2788
+ {
2789
+ "entity_id": "64211361-8759-414b-81c0-afbf24f83aa9"
2790
+ }
2791
+ ]
2792
+ },
2793
+ "_org": "728",
2794
+ "_created_at": "2022-06-03T15:52:27.512Z",
2795
+ "_updated_at": "2022-06-03T16:05:15.029Z",
2796
+ "price_options": {
2797
+ "$relation": [
2798
+ {
2799
+ "entity_id": "9c36c23b-1574-4193-beff-b1b5e1124bc7",
2800
+ "_tags": []
2801
+ },
2802
+ {
2803
+ "entity_id": "146aa2cc-f267-4d5e-bda4-cbe2669b7741",
2804
+ "_tags": []
2805
+ }
2806
+ ]
2807
+ }
2808
+ },
2809
+ "quantity": 16,
2810
+ "currency": "EUR",
2811
+ "description": "Solar Panel Module",
2812
+ "unit_amount": 100000,
2813
+ "unit_amount_net": 84034,
2814
+ "amount_subtotal": 1344538,
2815
+ "amount_total": 1600000
2816
+ },
2817
+ {
2818
+ "price_id": "146aa2cc-f267-4d5e-bda4-cbe2669b7741",
2819
+ "product_id": "a7f4771a-6368-4d77-bb01-71f1e4902de5",
2820
+ "taxes": [
2821
+ {
2822
+ "tax": {
2823
+ "_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc",
2824
+ "rate": "19",
2825
+ "behavior": "Inclusive",
2826
+ "_schema": "tax",
2827
+ "_org": "728",
2828
+ "_created_at": "2021-09-24T15:06:13.859Z",
2829
+ "_updated_at": "2022-04-04T17:36:15.273Z",
2830
+ "_title": "Tax Standard",
2831
+ "type": "VAT",
2832
+ "active": true,
2833
+ "region": "DE",
2834
+ "description": "Standard"
2835
+ },
2836
+ "amount": 31933
2837
+ }
2838
+ ],
2839
+ "_price": {
2840
+ "_id": "146aa2cc-f267-4d5e-bda4-cbe2669b7741",
2841
+ "unit_amount": 50000,
2842
+ "unit_amount_currency": "EUR",
2843
+ "unit_amount_decimal": "500",
2844
+ "sales_tax": "standard",
2845
+ "tax_behavior": "inclusive",
2846
+ "price_display_in_journeys": "show_price",
2847
+ "type": "one_time",
2848
+ "billing_period": "weekly",
2849
+ "billing_duration_unit": "months",
2850
+ "notice_time_unit": "months",
2851
+ "termination_time_unit": "months",
2852
+ "renewal_duration_unit": "months",
2853
+ "_schema": "price",
2854
+ "_title": "Battery Module 500amps",
2855
+ "description": "Battery Module 500amps",
2856
+ "active": true,
2857
+ "tax": {
2858
+ "$relation": [
2859
+ {
2860
+ "entity_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc"
2861
+ }
2862
+ ]
2863
+ },
2864
+ "_org": "728",
2865
+ "_created_at": "2022-06-03T16:05:04.391Z",
2866
+ "_updated_at": "2022-06-03T16:05:04.391Z"
2867
+ },
2868
+ "_product": {
2869
+ "_id": "a7f4771a-6368-4d77-bb01-71f1e4902de5",
2870
+ "type": "product",
2871
+ "_schema": "product",
2872
+ "_title": "Solar Panel with Battery Storage",
2873
+ "name": "Solar Panel with Battery Storage",
2874
+ "code": "SOLAR-BATT",
2875
+ "active": true,
2876
+ "description": "Solar Panel with battery solution, optimized for max efficiency. ",
2877
+ "feature": [
2878
+ {
2879
+ "_tags": [],
2880
+ "feature": "Eco-Panels"
2881
+ },
2882
+ {
2883
+ "_tags": [],
2884
+ "feature": "Remote Management Platform"
2885
+ },
2886
+ {
2887
+ "_tags": [],
2888
+ "feature": "Battery Remote Control"
2889
+ },
2890
+ {
2891
+ "_tags": [],
2892
+ "feature": "Mobile App"
2893
+ }
2894
+ ],
2895
+ "cross_sellable_products": {
2896
+ "$relation": [
2897
+ {
2898
+ "entity_id": "068d0713-a650-4668-9ed2-eca7be31e337",
2899
+ "_schema": "product",
2900
+ "_tags": []
2901
+ },
2902
+ {
2903
+ "entity_id": "c8402ee7-fba9-4f3d-bffd-6803ca655782",
2904
+ "_tags": []
2905
+ }
2906
+ ]
2907
+ },
2908
+ "product_images": {
2909
+ "$relation": [
2910
+ {
2911
+ "entity_id": "37bdeaaa-65fe-403e-9894-65b01cd277f1"
2912
+ },
2913
+ {
2914
+ "entity_id": "56dde657-795c-41bb-bf53-98fd586b7e6e"
2915
+ }
2916
+ ]
2917
+ },
2918
+ "product_downloads": {
2919
+ "$relation": [
2920
+ {
2921
+ "entity_id": "64211361-8759-414b-81c0-afbf24f83aa9"
2922
+ }
2923
+ ]
2924
+ },
2925
+ "_org": "728",
2926
+ "_created_at": "2022-06-03T15:52:27.512Z",
2927
+ "_updated_at": "2022-06-03T16:05:15.029Z",
2928
+ "price_options": {
2929
+ "$relation": [
2930
+ {
2931
+ "entity_id": "9c36c23b-1574-4193-beff-b1b5e1124bc7",
2932
+ "_tags": []
2933
+ },
2934
+ {
2935
+ "entity_id": "146aa2cc-f267-4d5e-bda4-cbe2669b7741",
2936
+ "_tags": []
2937
+ }
2938
+ ]
2939
+ }
2940
+ },
2941
+ "quantity": 4,
2942
+ "currency": "EUR",
2943
+ "description": "Battery Module 500amps",
2944
+ "unit_amount": 50000,
2945
+ "unit_amount_net": 42017,
2946
+ "amount_subtotal": 168067,
2947
+ "amount_total": 200000
2948
+ },
2949
+ {
2950
+ "price_id": "d88a8763-3e3d-4fc7-a7a5-2bc9117148bf",
2951
+ "product_id": "065d6618-cc59-45f4-8e3a-700edf6813c3",
2952
+ "_price": {
2953
+ "_id": "d88a8763-3e3d-4fc7-a7a5-2bc9117148bf",
2954
+ "unit_amount": 12055,
2955
+ "type": "recurring",
2956
+ "billing_period": "monthly",
2957
+ "billing_duration_amount": "8",
2958
+ "billing_duration_unit": "years",
2959
+ "notice_time_amount": "3",
2960
+ "notice_time_unit": "months",
2961
+ "termination_time_amount": "2",
2962
+ "termination_time_unit": "months",
2963
+ "renewal_duration_amount": "1",
2964
+ "renewal_duration_unit": "years",
2965
+ "active": true,
2966
+ "sales_tax": "reduced",
2967
+ "tax_behavior": "inclusive",
2968
+ "description": "Monthly",
2969
+ "billing_scheme": "per_unit",
2970
+ "tiers_mode": "Standard",
2971
+ "_schema": "price",
2972
+ "_org": "728",
2973
+ "_created_at": "2021-11-10T14:40:27.695Z",
2974
+ "_updated_at": "2021-12-14T18:16:33.248Z",
2975
+ "_title": "Monthly",
2976
+ "unit_amount_currency": "EUR",
2977
+ "unit_amount_decimal": "120.55456634"
2978
+ },
2979
+ "_product": {
2980
+ "_id": "065d6618-cc59-45f4-8e3a-700edf6813c3",
2981
+ "name": "Smartmeter: Schneider Electric PM5000 LCD Energiemessgerät / 3-phasig",
2982
+ "code": "1312378123",
2983
+ "_tags": [
2984
+ "wallbox",
2985
+ "review demo",
2986
+ "1"
2987
+ ],
2988
+ "categories": [
2989
+ "Power"
2990
+ ],
2991
+ "type": "product",
2992
+ "active": true,
2993
+ "feature": [
2994
+ {
2995
+ "_tags": [],
2996
+ "feature": "Bis zu 11 kW Ladeleistung (5x schneller laden)"
2997
+ },
2998
+ {
2999
+ "_tags": [],
3000
+ "feature": "Integrierter MID Zähler für eine kilowattstundengenaue Abrechnung*"
3001
+ },
3002
+ {
3003
+ "_tags": [],
3004
+ "feature": "Konfigurierbare Ladeleistung"
3005
+ },
3006
+ {
3007
+ "_tags": [],
3008
+ "feature": "Zugangskontrolle über RFID-Karten"
3009
+ },
3010
+ {
3011
+ "_tags": [],
3012
+ "feature": "Kommunikation über LAN"
3013
+ },
3014
+ {
3015
+ "_tags": [],
3016
+ "feature": "New feature"
3017
+ }
3018
+ ],
3019
+ "_schema": "product",
3020
+ "_org": "728",
3021
+ "_created_at": "2021-11-30T11:05:19.484Z",
3022
+ "_updated_at": "2022-01-13T09:18:29.944Z",
3023
+ "_title": "Smartmeter: Schneider Electric PM5000 LCD Energiemessgerät / 3-phasig",
3024
+ "price_options": {
3025
+ "$relation": [
3026
+ {
3027
+ "entity_id": "5264b089-fc6a-4a91-9a2a-80c673958faa"
3028
+ },
3029
+ {
3030
+ "entity_id": "d88a8763-3e3d-4fc7-a7a5-2bc9117148bf"
3031
+ }
3032
+ ]
3033
+ },
3034
+ "product_images": {
3035
+ "$relation": [
3036
+ {
3037
+ "entity_id": "16729e60-c527-44ef-93c9-c68b6acf1224"
3038
+ }
3039
+ ]
3040
+ }
3041
+ },
3042
+ "quantity": 1,
3043
+ "currency": "EUR",
3044
+ "description": "Monthly",
3045
+ "unit_amount": 12055,
3046
+ "unit_amount_net": 11267,
3047
+ "amount_subtotal": 11267,
3048
+ "amount_total": 12055,
3049
+ "taxes": [
3050
+ {
3051
+ "rate": "reduced",
3052
+ "amount": 789
3053
+ }
3054
+ ]
3055
+ },
3056
+ {
3057
+ "price_id": "e1ddf75a-d0d1-40b4-a07e-56e292867c88",
3058
+ "product_id": "5b9f05b7-f0f8-49c2-8a8d-0f8f923d6382",
3059
+ "_price": {
3060
+ "_id": "e1ddf75a-d0d1-40b4-a07e-56e292867c88",
3061
+ "unit_amount": 9900,
3062
+ "unit_amount_currency": "EUR",
3063
+ "unit_amount_decimal": "99",
3064
+ "sales_tax": "standard",
3065
+ "tax_behavior": "inclusive",
3066
+ "price_display_in_journeys": "show_price",
3067
+ "type": "recurring",
3068
+ "billing_period": "yearly",
3069
+ "billing_duration_unit": "months",
3070
+ "notice_time_unit": "months",
3071
+ "termination_time_unit": "months",
3072
+ "renewal_duration_unit": "months",
3073
+ "_schema": "price",
3074
+ "_title": "Yearly payment",
3075
+ "description": "Yearly payment",
3076
+ "active": true,
3077
+ "_org": "728",
3078
+ "_created_at": "2022-02-07T22:58:39.884Z",
3079
+ "_updated_at": "2022-02-07T22:58:39.884Z"
3080
+ },
3081
+ "_product": {
3082
+ "_id": "5b9f05b7-f0f8-49c2-8a8d-0f8f923d6382",
3083
+ "_schema": "product",
3084
+ "_title": "Yearly Payment Product",
3085
+ "name": "Yearly Payment Product",
3086
+ "type": "product",
3087
+ "active": true,
3088
+ "price_options": {
3089
+ "$relation": [
3090
+ {
3091
+ "entity_id": "e1ddf75a-d0d1-40b4-a07e-56e292867c88",
3092
+ "_tags": []
3093
+ }
3094
+ ]
3095
+ },
3096
+ "_org": "728",
3097
+ "_created_at": "2022-02-07T22:58:44.162Z",
3098
+ "_updated_at": "2022-02-08T09:34:08.026Z",
3099
+ "description": "Hier steht die Produktbeschreibung die sich auf dem Dokument, was generiert wird, gezogen wird."
3100
+ },
3101
+ "quantity": 1,
3102
+ "currency": "EUR",
3103
+ "description": "Yearly payment",
3104
+ "unit_amount": 9900,
3105
+ "unit_amount_net": 8319,
3106
+ "amount_subtotal": 8319,
3107
+ "amount_total": 9900,
3108
+ "taxes": [
3109
+ {
3110
+ "rate": "standard",
3111
+ "amount": 1581
3112
+ }
3113
+ ]
3114
+ }
3115
+ ],
3116
+ "amount_subtotal": 1532191,
3117
+ "amount_total": 1821955,
3118
+ "total_details": {
3119
+ "amount_tax": 289764,
3120
+ "breakdown": {
3121
+ "taxes": [
3122
+ {
3123
+ "tax": {
3124
+ "_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc",
3125
+ "rate": "19",
3126
+ "behavior": "Inclusive",
3127
+ "_schema": "tax",
3128
+ "_org": "728",
3129
+ "_created_at": "2021-09-24T15:06:13.859Z",
3130
+ "_updated_at": "2022-04-04T17:36:15.273Z",
3131
+ "_title": "Tax Standard",
3132
+ "type": "VAT",
3133
+ "active": true,
3134
+ "region": "DE",
3135
+ "description": "Standard"
3136
+ },
3137
+ "amount": 287395
3138
+ }
3139
+ ],
3140
+ "recurrences": [
3141
+ {
3142
+ "type": "one_time",
3143
+ "amount_subtotal": 1512605,
3144
+ "amount_total": 1800000,
3145
+ "amount_tax": 287395
3146
+ },
3147
+ {
3148
+ "type": "recurring",
3149
+ "billing_period": "monthly",
3150
+ "amount_subtotal": 11267,
3151
+ "amount_total": 12055,
3152
+ "amount_tax": 789
3153
+ },
3154
+ {
3155
+ "type": "recurring",
3156
+ "billing_period": "yearly",
3157
+ "amount_subtotal": 8319,
3158
+ "amount_total": 9900,
3159
+ "amount_tax": 1581
3160
+ }
3161
+ ]
3162
+ }
3163
+ },
3164
+ "currency": "EUR",
3165
+ "payment_method": [
3166
+ {
3167
+ "type": "IBAN",
3168
+ "details": {}
3169
+ }
3170
+ ],
3171
+ "billing_contact": {
3172
+ "$relation": [
3173
+ {
3174
+ "entity_id": "1834a54e-b68f-4f7f-a98a-fe16f11bc2a5",
3175
+ "_tags": []
3176
+ }
3177
+ ]
3178
+ },
3179
+ "billing_first_name": "Joao",
3180
+ "billing_last_name": "Pinho",
3181
+ "billing_email": "j.pinho@epilot.cloud",
3182
+ "billing_company_name": "epilot cloud",
3183
+ "billing_address": [
3184
+ {
3185
+ "_tags": [],
3186
+ "street": "Im Media Park",
3187
+ "street_number": "8a",
3188
+ "postal_code": "52000",
3189
+ "city": "Cologne",
3190
+ "country": "DE",
3191
+ "additional_info": ""
3192
+ }
3193
+ ],
3194
+ "delivery_address": [],
3195
+ "dates": [
3196
+ {
3197
+ "_tags": [
3198
+ "Instalation Date"
3199
+ ],
3200
+ "dates": "",
3201
+ "value": "2022-06-30T16:29:00.000Z"
3202
+ }
3203
+ ],
3204
+ "_id": "4c7c9562-f8f0-4af0-a3a6-6aebc5571a6e",
3205
+ "_org": "728",
3206
+ "_created_at": "2022-06-03T16:29:46.303Z",
3207
+ "_updated_at": "2022-06-03T16:29:46.303Z"
3208
+ }
3209
+ },
3210
+ "order-with-price-bundles": {
3211
+ "value": {
3212
+ "metadata": [
3213
+ {
3214
+ "key": "_origin",
3215
+ "value": "journey checkout"
3216
+ }
3217
+ ],
3218
+ "_tags": [
3219
+ "journey",
3220
+ "automation"
3221
+ ],
3222
+ "status": "quote",
3223
+ "order_number": "OREabZxnO",
3224
+ "billing_first_name": "Paulo",
3225
+ "billing_last_name": "Henriques",
3226
+ "billing_email": "ph@ph1.pt",
3227
+ "billing_address": [
3228
+ {
3229
+ "street": "Bernauer Str.",
3230
+ "street_number": "1",
3231
+ "city": "Berlin",
3232
+ "postal_code": "10115",
3233
+ "country": "DE",
3234
+ "additional_info": "1"
3235
+ }
3236
+ ],
3237
+ "delivery_address": [
3238
+ {
3239
+ "street": "Bernauer Str.",
3240
+ "street_number": "1",
3241
+ "city": "Berlin",
3242
+ "postal_code": "10115",
3243
+ "country": "DE",
3244
+ "additional_info": "1"
3245
+ }
3246
+ ],
3247
+ "payment_method": [
3248
+ {
3249
+ "type": "BankTransfer",
3250
+ "details": {
3251
+ "label": "Überweisung"
3252
+ }
3253
+ }
3254
+ ],
3255
+ "currency": "EUR",
3256
+ "line_items": [
3257
+ {
3258
+ "product_id": "73f857a4-0fbc-4aa6-983f-87c0d6d410a6",
3259
+ "price_id": "c2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3260
+ "quantity": 3,
3261
+ "currency": "EUR",
3262
+ "item_components": [
3263
+ {
3264
+ "price_id": "comp1-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3265
+ "product_id": "target-price-product-id",
3266
+ "quantity": 3,
3267
+ "unit_amount": 15000,
3268
+ "unit_amount_currency": "EUR",
3269
+ "unit_amount_decimal": "150.00",
3270
+ "amount_subtotal": 45000,
3271
+ "amount_total": 47700,
3272
+ "taxes": [
3273
+ {
3274
+ "tax": {
3275
+ "_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4",
3276
+ "type": "VAT",
3277
+ "behavior": "Exclusive",
3278
+ "active": true,
3279
+ "region": "DE",
3280
+ "_schema": "tax",
3281
+ "_title": "Tax Without Behaviour",
3282
+ "description": "Without Behaviour",
3283
+ "rate": "6",
3284
+ "_org": "739224",
3285
+ "_created_at": "2022-02-07T14:49:08.831Z",
3286
+ "_updated_at": "2022-02-07T14:49:08.831Z"
3287
+ },
3288
+ "amount": 2700
3289
+ }
3290
+ ]
3291
+ },
3292
+ {
3293
+ "price_id": "comp2-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3294
+ "product_id": "target-price-product-id",
3295
+ "quantity": 3,
3296
+ "unit_amount": 15000,
3297
+ "unit_amount_currency": "EUR",
3298
+ "unit_amount_decimal": "150.00",
3299
+ "amount_subtotal": 45000,
3300
+ "amount_total": 47700,
3301
+ "taxes": [
3302
+ {
3303
+ "tax": {
3304
+ "_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4",
3305
+ "type": "VAT",
3306
+ "behavior": "Exclusive",
3307
+ "active": true,
3308
+ "region": "DE",
3309
+ "_schema": "tax",
3310
+ "_title": "Tax Without Behaviour",
3311
+ "description": "Without Behaviour",
3312
+ "rate": "6",
3313
+ "_org": "739224",
3314
+ "_created_at": "2022-02-07T14:49:08.831Z",
3315
+ "_updated_at": "2022-02-07T14:49:08.831Z"
3316
+ },
3317
+ "amount": 2700
3318
+ }
3319
+ ]
3320
+ }
3321
+ ],
3322
+ "_price": {
3323
+ "_id": "c2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3324
+ "_schema": "price",
3325
+ "_title": "Test 1",
3326
+ "description": "Test 1",
3327
+ "_org": "739224",
3328
+ "_created_at": "2022-02-18T10:10:26.439Z",
3329
+ "_updated_at": "2022-02-18T11:53:04.191Z",
3330
+ "active": true,
3331
+ "price_components": {
3332
+ "$relation": [
3333
+ {
3334
+ "entity_id": "comp1-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3335
+ "_schema": "price",
3336
+ "_product_id": "target-price-product-id",
3337
+ "quantity": 1,
3338
+ "item": {
3339
+ "_id": "comp1-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3340
+ "unit_amount": 10000,
3341
+ "unit_amount_currency": "EUR",
3342
+ "unit_amount_decimal": "100.00",
3343
+ "sales_tax": "standard",
3344
+ "tax_behavior": "exclusive",
3345
+ "price_display_in_journeys": "show_price",
3346
+ "type": "one_time",
3347
+ "_schema": "price",
3348
+ "_title": "Test 1",
3349
+ "description": "Test 1",
3350
+ "tax": {
3351
+ "$relation": [
3352
+ {
3353
+ "entity_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4"
3354
+ }
3355
+ ]
3356
+ },
3357
+ "_org": "739224",
3358
+ "_created_at": "2022-02-18T10:10:26.439Z",
3359
+ "_updated_at": "2022-02-18T11:53:04.191Z",
3360
+ "active": true,
3361
+ "billing_period": "weekly",
3362
+ "billing_duration_unit": "months",
3363
+ "notice_time_unit": "months",
3364
+ "termination_time_unit": "months",
3365
+ "renewal_duration_unit": "months"
3366
+ }
3367
+ },
3368
+ {
3369
+ "entity_id": "comp2-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3370
+ "_schema": "price",
3371
+ "_product_id": "target-price-product-id",
3372
+ "quantity": 2,
3373
+ "item": {
3374
+ "_id": "comp2-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3375
+ "unit_amount": 10000,
3376
+ "unit_amount_currency": "EUR",
3377
+ "unit_amount_decimal": "100.00",
3378
+ "sales_tax": "standard",
3379
+ "tax_behavior": "exclusive",
3380
+ "price_display_in_journeys": "show_price",
3381
+ "type": "one_time",
3382
+ "_schema": "price",
3383
+ "_title": "Test 1",
3384
+ "description": "Test 1",
3385
+ "tax": {
3386
+ "$relation": [
3387
+ {
3388
+ "entity_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4"
3389
+ }
3390
+ ]
3391
+ },
3392
+ "_org": "739224",
3393
+ "_created_at": "2022-02-18T10:10:26.439Z",
3394
+ "_updated_at": "2022-02-18T11:53:04.191Z",
3395
+ "active": true,
3396
+ "billing_period": "weekly",
3397
+ "billing_duration_unit": "months",
3398
+ "notice_time_unit": "months",
3399
+ "termination_time_unit": "months",
3400
+ "renewal_duration_unit": "months"
3401
+ }
3402
+ }
3403
+ ]
3404
+ }
3405
+ },
3406
+ "_product": {
3407
+ "_id": "73f857a4-0fbc-4aa6-983f-87c0d6d410a6",
3408
+ "type": "product",
3409
+ "name": "Cool box",
3410
+ "_title": "Cool box"
3411
+ },
3412
+ "description": "Price Bundle - Test 1",
3413
+ "unit_amount": 90000,
3414
+ "amount_subtotal": 270000,
3415
+ "amount_total": 286200
3416
+ },
3417
+ {
3418
+ "price_id": "adbd8cee-0db2-41dd-b93b-2d0ed57c77da",
3419
+ "product_id": "11bd46e5-4c02-425c-bcce-5f5e022a2b45",
3420
+ "taxes": [
3421
+ {
3422
+ "tax": null,
3423
+ "amount": 0
3424
+ }
3425
+ ],
3426
+ "_price": {
3427
+ "_id": "adbd8cee-0db2-41dd-b93b-2d0ed57c77da",
3428
+ "unit_amount": 55566677,
3429
+ "unit_amount_currency": "EUR",
3430
+ "unit_amount_decimal": "555666.77",
3431
+ "sales_tax": "standard",
3432
+ "tax_behavior": "inclusive",
3433
+ "price_display_in_journeys": "show_as_starting_price",
3434
+ "type": "one_time",
3435
+ "_schema": "price",
3436
+ "_title": "As Starting Price One Time No Tax",
3437
+ "description": "As Starting Price One Time No Tax",
3438
+ "tax": null,
3439
+ "active": true,
3440
+ "_org": "739224",
3441
+ "_created_at": "2022-04-14T16:12:34.456Z",
3442
+ "_updated_at": "2022-04-14T16:13:47.261Z",
3443
+ "billing_period": "weekly",
3444
+ "billing_duration_unit": "months",
3445
+ "notice_time_unit": "months",
3446
+ "termination_time_unit": "months",
3447
+ "renewal_duration_unit": "months"
3448
+ },
3449
+ "_product": {
3450
+ "_id": "11bd46e5-4c02-425c-bcce-5f5e022a2b45",
3451
+ "type": "product",
3452
+ "_schema": "product",
3453
+ "_title": "Product With A Lot Of Prices - Do Not Change 🙏",
3454
+ "name": "Product With A Lot Of Prices - Do Not Change 🙏",
3455
+ "_org": "739224",
3456
+ "_created_at": "2022-04-14T16:08:08.595Z",
3457
+ "_updated_at": "2022-04-18T16:26:33.089Z",
3458
+ "price_options": {
3459
+ "$relation": [
3460
+ {
3461
+ "entity_id": "f850ebff-082e-4924-8631-965cc9c0ab2b",
3462
+ "_tags": []
3463
+ },
3464
+ {
3465
+ "entity_id": "d6ecc576-b5d6-44b4-8c95-496ab2ac14d3",
3466
+ "_tags": []
3467
+ },
3468
+ {
3469
+ "entity_id": "3c0e47ad-6ca3-4cd8-b6b4-b2a48dab7f16",
3470
+ "_tags": []
3471
+ },
3472
+ {
3473
+ "entity_id": "adbd8cee-0db2-41dd-b93b-2d0ed57c77da",
3474
+ "_tags": []
3475
+ },
3476
+ {
3477
+ "entity_id": "3e97f809-1d4b-47e1-9faf-46386b2b0d21",
3478
+ "_tags": []
3479
+ },
3480
+ {
3481
+ "entity_id": "d4061656-71dc-45ec-bf6c-1d90d2419d87",
3482
+ "_tags": []
3483
+ },
3484
+ {
3485
+ "entity_id": "4ae4221b-4fd0-4bcc-98a2-f20cda954903",
3486
+ "_tags": []
3487
+ },
3488
+ {
3489
+ "entity_id": "b326df19-9d0f-433a-a4d2-a0a65034b5f7",
3490
+ "_tags": []
3491
+ },
3492
+ {
3493
+ "entity_id": "0d071551-47be-4a5b-90d7-d425a59607e6",
3494
+ "_tags": []
3495
+ }
3496
+ ]
3497
+ },
3498
+ "_files": {
3499
+ "$relation": [
3500
+ {
3501
+ "entity_id": "27cc0710-651d-48dc-9624-9d1d3057d025",
3502
+ "_tags": []
3503
+ },
3504
+ {
3505
+ "entity_id": "8530678c-d4cb-4e27-b314-16a79d6c0abc",
3506
+ "_tags": []
3507
+ },
3508
+ {
3509
+ "entity_id": "714d6253-213f-4e30-8caf-00b0d11032e4",
3510
+ "_tags": []
3511
+ },
3512
+ {
3513
+ "entity_id": "2218a8f8-c6e2-4a98-a2fe-030ed78ebfa7",
3514
+ "_tags": []
3515
+ }
3516
+ ]
3517
+ }
3518
+ },
3519
+ "quantity": 7,
3520
+ "currency": "EUR",
3521
+ "description": "As Starting Price One Time No Tax",
3522
+ "unit_amount": 55566677,
3523
+ "amount_subtotal": 388966739,
3524
+ "amount_total": 388966739
3525
+ }
3526
+ ],
3527
+ "amount_subtotal": 389236739,
3528
+ "amount_total": 389252939,
3529
+ "total_details": {
3530
+ "amount_tax": 5400,
3531
+ "breakdown": {
3532
+ "taxes": [
3533
+ {
3534
+ "tax": {
3535
+ "_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4",
3536
+ "type": "VAT",
3537
+ "behavior": "Exclusive",
3538
+ "active": true,
3539
+ "region": "DE",
3540
+ "_schema": "tax",
3541
+ "_title": "Tax Without Behaviour",
3542
+ "description": "Without Behaviour",
3543
+ "rate": "6",
3544
+ "_org": "739224",
3545
+ "_created_at": "2022-02-07T14:49:08.831Z",
3546
+ "_updated_at": "2022-02-07T14:49:08.831Z"
3547
+ },
3548
+ "amount": 5400
3549
+ }
3550
+ ],
3551
+ "recurrences": [
3552
+ {
3553
+ "type": "one_time",
3554
+ "amount_subtotal": 389236739,
3555
+ "amount_total": 389252939,
3556
+ "amount_tax": 5400
3557
+ }
3558
+ ]
3559
+ }
3560
+ },
3561
+ "_schema": "order",
3562
+ "_id": "78ac88ae-d7df-4a1e-a26b-acaf089abfb2",
3563
+ "_org": "739224",
3564
+ "_created_at": "2022-04-19T08:19:29.816Z",
3565
+ "_updated_at": "2022-04-20T16:15:48.759Z",
3566
+ "_title": "OREabZxnO",
3567
+ "customer": {
3568
+ "$relation": [
3569
+ {
3570
+ "entity_id": "bb986d50-f403-477c-9d9c-726f8fd6d155"
3571
+ }
3572
+ ]
3573
+ }
3574
+ }
3575
+ },
3576
+ "opportunity": {
3577
+ "value": {
3578
+ "opportunity_number": "OP 2022/335790",
3579
+ "source": {
3580
+ "title": "manual"
3581
+ },
3582
+ "source_type": "manual",
3583
+ "_schema": "opportunity",
3584
+ "_title": "16 Module Solar Pack Lead",
3585
+ "opportunity_title": "16 Module Solar Pack Lead",
3586
+ "due_date": "2022-06-30T15:18:00.000Z",
3587
+ "assignee": [
3588
+ {
3589
+ "id": "10002563",
3590
+ "email": "j.pinho@epilot.cloud",
3591
+ "display_name": "j.pinho@epilot.cloud",
3592
+ "token": "9e1758a3-2a32-4a5f-b034-a8ab883f8fb9",
3593
+ "image_uri": {},
3594
+ "organization_id": "728",
3595
+ "department": null,
3596
+ "preferred_language": "en",
3597
+ "status": "Active",
3598
+ "phone": null,
3599
+ "email_notification_setting": {
3600
+ "added_participant_opportunity": true,
3601
+ "assigned_opportunity": true,
3602
+ "assigned_task": true,
3603
+ "comment_opportunity": true,
3604
+ "deleted_task": true,
3605
+ "escalated_task": true,
3606
+ "message_receive_opportunity": true,
3607
+ "message_send_opportunity": true,
3608
+ "created_task": true,
3609
+ "created_opportunity_manual": true,
3610
+ "created_opportunity_auto": true,
3611
+ "deleted_opportunity": true
3612
+ },
3613
+ "is_signature_enabled": true,
3614
+ "created_at": "2021-05-18T06:30:25.36046"
3615
+ }
3616
+ ],
3617
+ "description": "Lead generated automatically via journey automation.",
3618
+ "customer": {
3619
+ "$relation": [
3620
+ {
3621
+ "entity_id": "69bf4355-9c1e-498a-b87e-6c873668194d",
3622
+ "_tags": []
3623
+ },
3624
+ {
3625
+ "entity_id": "8625e2e4-978e-4d16-b3d2-0d05fb4091f0",
3626
+ "_tags": []
3627
+ }
1914
3628
  ]
1915
3629
  },
1916
- "description": {
1917
- "type": "string"
1918
- },
1919
- "rate": {
1920
- "type": "number"
3630
+ "dates": [
3631
+ {
3632
+ "_tags": [
3633
+ "Installation Date"
3634
+ ],
3635
+ "dates": "",
3636
+ "value": "2022-06-30T15:21:00.000Z"
3637
+ }
3638
+ ],
3639
+ "items": {
3640
+ "$relation": [
3641
+ {
3642
+ "entity_id": "ff5fcdaf-9e36-4292-97f0-6a4e3f82a8f3"
3643
+ },
3644
+ {
3645
+ "entity_id": "ec10b7cf-95ce-4f6b-a266-c566c7734b96"
3646
+ },
3647
+ {
3648
+ "entity_id": "c3745dfe-4a46-4c22-8bf3-6159303474e4"
3649
+ }
3650
+ ]
1921
3651
  },
1922
- "behavior": {
1923
- "type": "string",
1924
- "enum": [
1925
- "Exclusive",
1926
- "Inclusive"
3652
+ "billing_address": {
3653
+ "$relation_ref": [
3654
+ {
3655
+ "entity_id": "69bf4355-9c1e-498a-b87e-6c873668194d",
3656
+ "path": "address.2"
3657
+ }
1927
3658
  ]
1928
3659
  },
1929
- "active": {
1930
- "type": "boolean"
3660
+ "delivery_address": {
3661
+ "$relation_ref": [
3662
+ {
3663
+ "entity_id": "69bf4355-9c1e-498a-b87e-6c873668194d",
3664
+ "path": "address.24"
3665
+ }
3666
+ ]
1931
3667
  },
1932
- "region": {
1933
- "type": "string"
3668
+ "address": {
3669
+ "$relation_ref": [
3670
+ {
3671
+ "entity_id": "69bf4355-9c1e-498a-b87e-6c873668194d",
3672
+ "path": "address.25"
3673
+ }
3674
+ ]
1934
3675
  },
1935
- "region_label": {
1936
- "type": "string"
1937
- }
1938
- }
1939
- }
1940
- },
1941
- "examples": {
1942
- "checkoutWithCartId": {
1943
- "value": {
1944
- "mode": "create_order",
1945
- "cart": "pZ324jnndf"
3676
+ "_id": "319a274b-0477-45e3-9d58-1f46c82d4604",
3677
+ "_org": "728",
3678
+ "_created_at": "2022-06-03T15:26:14.006Z",
3679
+ "_updated_at": "2022-06-03T15:26:14.006Z"
1946
3680
  }
1947
3681
  },
1948
- "checkoutWithTransientCart": {
3682
+ "product": {
1949
3683
  "value": {
1950
- "mode": "create_order",
1951
- "cart": {
1952
- "metadata": [
1953
- {
1954
- "key": "journey-id",
1955
- "value": "8d0a2235-97ce-42d0-88a3-e374634ca44e"
1956
- }
1957
- ],
1958
- "customer": {
1959
- "first_name": "john",
1960
- "last_name": "doe",
1961
- "company_name": "company limited",
1962
- "vat_id": "123892321",
1963
- "email": "johndoe@company.com",
1964
- "phone": "+44233242423"
3684
+ "type": "product",
3685
+ "_schema": "product",
3686
+ "_title": "Solar Panel with Battery Storage",
3687
+ "name": "Solar Panel with Battery Storage",
3688
+ "code": "SOLAR-BATT",
3689
+ "active": true,
3690
+ "description": "Solar Panel with battery solution, optimized for max efficiency. ",
3691
+ "feature": [
3692
+ {
3693
+ "_tags": [],
3694
+ "feature": "Eco-Panels"
1965
3695
  },
1966
- "billing_address": {
1967
- "street1": "wallstreet",
1968
- "street2": 1,
1969
- "city": "new york city",
1970
- "country": "united states",
1971
- "country_code": "US",
1972
- "additional_info": "headquarters office"
3696
+ {
3697
+ "_tags": [],
3698
+ "feature": "Remote Management Platform"
1973
3699
  },
1974
- "delivery_address": {
1975
- "street1": "berverly hills avenue",
1976
- "street2": "block 1",
1977
- "city": "berverly hills",
1978
- "country": "california",
1979
- "country_code": "CA",
1980
- "additional_info": "remote cowork place"
3700
+ {
3701
+ "_tags": [],
3702
+ "feature": "Battery Remote Control"
1981
3703
  },
1982
- "line_items": [
3704
+ {
3705
+ "_tags": [],
3706
+ "feature": "Mobile App"
3707
+ }
3708
+ ],
3709
+ "cross_sellable_products": {
3710
+ "$relation": [
1983
3711
  {
1984
- "quantity": 1,
1985
- "product": "b7185fb7-b10f-4875-bda7-288631446555",
1986
- "price": "df240bab-9f71-4a9a-a9e1-59f18827dbf9"
3712
+ "entity_id": "068d0713-a650-4668-9ed2-eca7be31e337",
3713
+ "_schema": "product",
3714
+ "_tags": []
1987
3715
  },
1988
3716
  {
1989
- "quantity": 1,
1990
- "product": "zzzzzz-b10f-4875-bda7-288631446555",
1991
- "price": "zzzzz-9f71-4a9a-a9e1-59f18827dbf9"
3717
+ "entity_id": "c8402ee7-fba9-4f3d-bffd-6803ca655782",
3718
+ "_tags": []
3719
+ }
3720
+ ]
3721
+ },
3722
+ "product_images": {
3723
+ "$relation": [
3724
+ {
3725
+ "entity_id": "37bdeaaa-65fe-403e-9894-65b01cd277f1"
3726
+ },
3727
+ {
3728
+ "entity_id": "56dde657-795c-41bb-bf53-98fd586b7e6e"
3729
+ }
3730
+ ]
3731
+ },
3732
+ "product_downloads": {
3733
+ "$relation": [
3734
+ {
3735
+ "entity_id": "64211361-8759-414b-81c0-afbf24f83aa9"
3736
+ }
3737
+ ]
3738
+ },
3739
+ "_id": "a7f4771a-6368-4d77-bb01-71f1e4902de5",
3740
+ "_org": "728",
3741
+ "_created_at": "2022-06-03T15:52:27.512Z",
3742
+ "_updated_at": "2022-06-03T16:05:15.029Z",
3743
+ "price_options": {
3744
+ "$relation": [
3745
+ {
3746
+ "entity_id": "9c36c23b-1574-4193-beff-b1b5e1124bc7",
3747
+ "_tags": []
3748
+ },
3749
+ {
3750
+ "entity_id": "146aa2cc-f267-4d5e-bda4-cbe2669b7741",
3751
+ "_tags": []
1992
3752
  }
1993
- ],
1994
- "files": [
1995
- "xf240bab-9f71-4a9a-a9e1-59f18827dbf9",
1996
- "yf240bab-9f71-4a9a-a9e1-59f18827dbf9",
1997
- "zf240bab-9f71-4a9a-a9e1-59f18827dbf9"
1998
3753
  ]
1999
3754
  }
2000
3755
  }
2001
3756
  },
2002
- "checkoutResult": {
3757
+ "price": {
2003
3758
  "value": {
2004
- "order": {
2005
- "_id": "d1ZoC1FwZ6",
2006
- "type": "Draft",
2007
- "cart_id": "p0ZoB1FwH6",
2008
- "order_number": "20201021-234324",
2009
- "_org_id": 123,
2010
- "metadata": [
3759
+ "unit_amount": 100000,
3760
+ "unit_amount_currency": "EUR",
3761
+ "unit_amount_decimal": "1000",
3762
+ "sales_tax": "standard",
3763
+ "tax_behavior": "inclusive",
3764
+ "price_display_in_journeys": "show_price",
3765
+ "type": "one_time",
3766
+ "billing_period": "weekly",
3767
+ "billing_duration_unit": "months",
3768
+ "notice_time_unit": "months",
3769
+ "termination_time_unit": "months",
3770
+ "renewal_duration_unit": "months",
3771
+ "_schema": "price",
3772
+ "_title": "Solar Panel Module",
3773
+ "description": "Solar Panel Module",
3774
+ "active": true,
3775
+ "tax": {
3776
+ "$relation": [
2011
3777
  {
2012
- "key": "journey-id",
2013
- "value": "8d0a2235-97ce-42d0-88a3-e374634ca44e"
3778
+ "entity_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc"
2014
3779
  }
2015
- ],
2016
- "billing_first_name": "john",
2017
- "billing_last_name": "doe",
2018
- "billing_company_name": "i me and myself",
2019
- "billing_vat": "234823948",
2020
- "billing_email": "johndoe@nowhere.com",
2021
- "currency": "EUR",
2022
- "billing_phone": "+1234234545",
2023
- "billing_address": "wallstreet, 1",
2024
- "billing_contact": "villy or zilly",
2025
- "line_items": [
3780
+ ]
3781
+ },
3782
+ "_id": "9c36c23b-1574-4193-beff-b1b5e1124bc7",
3783
+ "_org": "728",
3784
+ "_created_at": "2022-06-03T16:04:10.369Z",
3785
+ "_updated_at": "2022-06-03T16:04:10.369Z"
3786
+ }
3787
+ },
3788
+ "price-bundle": {
3789
+ "value": {
3790
+ "_id": "c2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3791
+ "_schema": "price",
3792
+ "_title": "My Price Bundle",
3793
+ "description": "My Price Bundle",
3794
+ "_org": "739224",
3795
+ "_created_at": "2022-02-18T10:10:26.439Z",
3796
+ "_updated_at": "2022-02-18T11:53:04.191Z",
3797
+ "active": true,
3798
+ "price_components": {
3799
+ "$relation": [
2026
3800
  {
2027
- "id": "mSjGCTfn8w",
2028
- "metadata": [
2029
- {
2030
- "cart_id": "p0ZoB1FwH6"
2031
- }
2032
- ],
2033
- "description": "Wallbox Premium - Premium Price",
2034
- "currency": "EUR",
2035
- "unit_amount": 78900,
2036
- "amount_subtotal": 50000,
2037
- "amount_total": 61500,
3801
+ "entity_id": "comp1-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3802
+ "_schema": "price",
3803
+ "_product_id": "target-price-product-id",
2038
3804
  "quantity": 1,
2039
- "product_id": "b7185fb7-b10f-4875-bda7-288631446555",
2040
- "price_id": "df240bab-9f71-4a9a-a9e1-59f18827dbf9",
2041
- "taxes": [
2042
- {
2043
- "amount": 11500,
2044
- "rate": "MwSt. 23%"
2045
- }
2046
- ],
2047
- "_price": {
2048
- "_id": "df240bab-9f71-4a9a-a9e1-59f18827dbf9",
2049
- "unit_amount": "€ 789",
3805
+ "item": {
3806
+ "_id": "comp1-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3807
+ "unit_amount": 10000,
3808
+ "unit_amount_currency": "EUR",
3809
+ "unit_amount_decimal": "100.00",
3810
+ "sales_tax": "standard",
3811
+ "tax_behavior": "exclusive",
3812
+ "price_display_in_journeys": "show_price",
2050
3813
  "type": "one_time",
3814
+ "_schema": "price",
3815
+ "_title": "Test 1",
3816
+ "description": "Test 1",
3817
+ "tax": {
3818
+ "$relation": [
3819
+ {
3820
+ "entity_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4"
3821
+ }
3822
+ ]
3823
+ },
3824
+ "_org": "739224",
3825
+ "_created_at": "2022-02-18T10:10:26.439Z",
3826
+ "_updated_at": "2022-02-18T11:53:04.191Z",
2051
3827
  "active": true,
2052
- "sales_tax": "standard",
2053
- "tax_behavior": "inclusive",
2054
- "description": "Winter Sale",
2055
- "billing_scheme": "Per Unit",
2056
- "tiers_mode": "Standard",
2057
- "_created_at": "2021-11-10T18:02:58.318Z",
2058
- "_updated_at": "2021-11-10T18:02:58.318Z",
2059
- "_title": "Winter Sale"
3828
+ "billing_period": "weekly",
3829
+ "billing_duration_unit": "months",
3830
+ "notice_time_unit": "months",
3831
+ "termination_time_unit": "months",
3832
+ "renewal_duration_unit": "months"
2060
3833
  }
2061
3834
  },
2062
3835
  {
2063
- "id": "mZkGCTfn6p",
2064
- "metadata": [
2065
- {
2066
- "cart_id": "p0ZoB1FwH6"
2067
- }
2068
- ],
2069
- "description": "Wallbox Basic with Full Add-ons - Basic Price",
2070
- "currency": "EUR",
2071
- "unit_amount": 78900,
2072
- "amount_subtotal": 50000,
2073
- "amount_total": 53500,
2074
- "quantity": 1,
2075
- "product_id": "zzzzzz-b10f-4875-bda7-288631446555",
2076
- "price_id": "zzzzz-9f71-4a9a-a9e1-59f18827dbf9",
2077
- "taxes": [
2078
- {
2079
- "amount": 3500,
2080
- "rate": "MwSt. 7%"
2081
- }
2082
- ],
2083
- "_price": {
2084
- "_id": "zzzzz-9f71-4a9a-a9e1-59f18827dbf9",
2085
- "unit_amount": "€ 789",
3836
+ "entity_id": "comp2-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3837
+ "_schema": "price",
3838
+ "_product_id": "target-price-product-id",
3839
+ "quantity": 2,
3840
+ "item": {
3841
+ "_id": "comp2-2a95ca9-7a50-41a4-a73c-b5fb1a57d40f",
3842
+ "unit_amount": 10000,
3843
+ "unit_amount_currency": "EUR",
3844
+ "unit_amount_decimal": "100.00",
3845
+ "sales_tax": "standard",
3846
+ "tax_behavior": "exclusive",
3847
+ "price_display_in_journeys": "show_price",
2086
3848
  "type": "one_time",
3849
+ "_schema": "price",
3850
+ "_title": "Test 1",
3851
+ "description": "Test 1",
3852
+ "tax": {
3853
+ "$relation": [
3854
+ {
3855
+ "entity_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4"
3856
+ }
3857
+ ]
3858
+ },
3859
+ "_org": "739224",
3860
+ "_created_at": "2022-02-18T10:10:26.439Z",
3861
+ "_updated_at": "2022-02-18T11:53:04.191Z",
2087
3862
  "active": true,
2088
- "sales_tax": "standard",
2089
- "tax_behavior": "inclusive",
2090
- "description": "Winter Sale",
2091
- "billing_scheme": "Per Unit",
2092
- "tiers_mode": "Standard",
2093
- "_created_at": "2021-11-10T18:02:58.318Z",
2094
- "_updated_at": "2021-11-10T18:02:58.318Z",
2095
- "_title": "Winter Sale"
3863
+ "billing_period": "weekly",
3864
+ "billing_duration_unit": "months",
3865
+ "notice_time_unit": "months",
3866
+ "termination_time_unit": "months",
3867
+ "renewal_duration_unit": "months"
2096
3868
  }
2097
3869
  }
2098
- ],
2099
- "amount_subtotal": 100000,
2100
- "amount_total": 115000,
2101
- "total_details": {
2102
- "amount_shipping": 10000,
2103
- "amount_tax": 15000,
2104
- "breakdown": [
2105
- {
2106
- "amount": 11500,
2107
- "rate": "MwSt. 23%"
2108
- },
2109
- {
2110
- "amount": 3500,
2111
- "rate": "MwSt. 7%"
2112
- }
2113
- ]
2114
- },
2115
- "_created_at": "2021-11-10T18:02:58.318Z",
2116
- "_updated_at": "2021-11-10T18:02:58.318Z"
3870
+ ]
2117
3871
  }
2118
3872
  }
2119
3873
  }
2120
3874
  }
2121
- },
2122
- "servers": [
2123
- {
2124
- "url": "https://pricing-api.sls.epilot.io"
2125
- },
2126
- {
2127
- "url": "https://pricing-api.sls.epilot.io"
2128
- }
2129
- ]
3875
+ }
2130
3876
  }