Create a product item

POST

/v:version/product-items

POST

/v:version/product-items

1 curl -X POST https://test.api.solvimon.com/v1/product-items \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "reference": "string",
6   "product_id": "prod_jwDeAN0tsJCV11BBeT1h",
7   "name": "reimbursed_amount",
8   "description": "reimbursed amount",
9   "model_type": "USAGE_BASED",
10   "tax_category": "STANDARD",
11   "meter_value_calculation_id": "bmet_AwDeeF0tu31PTQAbeN1t"
12 }'

1 {
2   "reference": "string",
3   "object_type": "string",
4   "id": "string",
5   "product_id": "string",
6   "product": {
7     "category_id": "string",
8     "name": "string",
9     "reference": "string",
10     "product_type": "DEFAULT",
11     "object_type": "string",
12     "id": "string",
13     "category": {
14       "name": "string",
15       "reference": "string",
16       "object_type": "string",
17       "id": "string",
18       "description": "string",
19       "tax_category": "STANDARD",
20       "display_order": 1
21     },
22     "parent_product_id": "string",
23     "description": "string",
24     "status": "DRAFT",
25     "tax_category": "STANDARD",
26     "features": [
27       {
28         "reference": "string",
29         "id": "string"
30       }
31     ],
32     "custom_fields": [
33       {
34         "id": "string",
35         "reference": "string",
36         "value": "string",
37         "values": [
38           "string"
39         ],
40         "integration_details": {
41           "payment_gateway_variant": "ADYEN",
42           "id": "string",
43           "reference": "string",
44           "adyen": {
45             "recurring_detail_reference": "string"
46           },
47           "stripe": {
48             "payment_method_id": "string"
49           }
50         }
51       }
52     ],
53     "display_order": 1,
54     "linked_integrations": [
55       {
56         "id": "string",
57         "link_details": [
58           {
59             "url": "string",
60             "custom_field_name": "string"
61           }
62         ]
63       }
64     ],
65     "billing_entity_id": "string"
66   },
67   "name": "string",
68   "status": "DRAFT",
69   "description": "string",
70   "type": "REVENUE",
71   "model_type": "USAGE_BASED",
72   "usage_based": {
73     "meter_value_calculation_id": "string",
74     "meter_value_calculation": {
75       "reference": "string",
76       "object_type": "string",
77       "id": "string",
78       "name": "string",
79       "description": "string",
80       "calculation_type": "SUM",
81       "persist": true,
82       "meter_id": "string",
83       "meter": {
84         "reference": "string",
85         "object_type": "string",
86         "id": "string",
87         "name": "string",
88         "description": "string",
89         "status": "DRAFT",
90         "meter_values": [
91           {
92             "id": "string",
93             "object": {
94               "reference": "string",
95               "object_type": "string",
96               "id": "string",
97               "name": "string",
98               "description": "string",
99               "status": "DRAFT",
100               "type": "NUMBER"
101             },
102             "required": true
103           }
104         ],
105         "meter_properties": [
106           {
107             "id": "string",
108             "object": {
109               "reference": "string",
110               "status": "DRAFT",
111               "object_type": "string",
112               "id": "string",
113               "name": "string",
114               "description": "string",
115               "type": "NUMBER",
116               "enum_values": [
117                 "string"
118               ]
119             },
120             "required": true
121           }
122         ]
123       },
124       "meter_value_id": "string",
125       "meter_value": {
126         "reference": "string",
127         "object_type": "string",
128         "id": "string",
129         "name": "string",
130         "description": "string",
131         "status": "DRAFT",
132         "type": "NUMBER"
133       },
134       "meter_property_id": "string",
135       "meter_property": {
136         "reference": "string",
137         "status": "DRAFT",
138         "object_type": "string",
139         "id": "string",
140         "name": "string",
141         "description": "string",
142         "type": "NUMBER",
143         "enum_values": [
144           "string"
145         ]
146       }
147     },
148     "tiering_meter_value_calculation_id": "string",
149     "tiering_meter_value_calculation": {
150       "reference": "string",
151       "object_type": "string",
152       "id": "string",
153       "name": "string",
154       "description": "string",
155       "calculation_type": "SUM",
156       "persist": true,
157       "meter_id": "string",
158       "meter": {
159         "reference": "string",
160         "object_type": "string",
161         "id": "string",
162         "name": "string",
163         "description": "string",
164         "status": "DRAFT",
165         "meter_values": [
166           {
167             "id": "string",
168             "object": {
169               "reference": "string",
170               "object_type": "string",
171               "id": "string",
172               "name": "string",
173               "description": "string",
174               "status": "DRAFT",
175               "type": "NUMBER"
176             },
177             "required": true
178           }
179         ],
180         "meter_properties": [
181           {
182             "id": "string",
183             "object": {
184               "reference": "string",
185               "status": "DRAFT",
186               "object_type": "string",
187               "id": "string",
188               "name": "string",
189               "description": "string",
190               "type": "NUMBER",
191               "enum_values": [
192                 "string"
193               ]
194             },
195             "required": true
196           }
197         ]
198       },
199       "meter_value_id": "string",
200       "meter_value": {
201         "reference": "string",
202         "object_type": "string",
203         "id": "string",
204         "name": "string",
205         "description": "string",
206         "status": "DRAFT",
207         "type": "NUMBER"
208       },
209       "meter_property_id": "string",
210       "meter_property": {
211         "reference": "string",
212         "status": "DRAFT",
213         "object_type": "string",
214         "id": "string",
215         "name": "string",
216         "description": "string",
217         "type": "NUMBER",
218         "enum_values": [
219           "string"
220         ]
221       }
222     },
223     "report_meter_value_calculation_ids": [
224       "string"
225     ],
226     "conditions": {
227       "name": "string",
228       "expression": {
229         "operator": "AND",
230         "operands": [
231           {
232             "meter_property": {
233               "comparator": "EQUALS",
234               "id": "string",
235               "reference": "string",
236               "meter_property": {
237                 "reference": "string",
238                 "status": "DRAFT",
239                 "object_type": "string",
240                 "id": "string",
241                 "name": "string",
242                 "description": "string",
243                 "type": "NUMBER",
244                 "enum_values": [
245                   "string"
246                 ]
247               },
248               "value": "string",
249               "values": [
250                 "string"
251               ]
252             },
253             "expression": {}
254           }
255         ]
256       },
257       "meter_properties": [
258         {
259           "comparator": "EQUALS",
260           "id": "string",
261           "reference": "string",
262           "meter_property": {
263             "reference": "string",
264             "status": "DRAFT",
265             "object_type": "string",
266             "id": "string",
267             "name": "string",
268             "description": "string",
269             "type": "NUMBER",
270             "enum_values": [
271               "string"
272             ]
273           },
274           "value": "string",
275           "values": [
276             "string"
277           ]
278         }
279       ]
280     }
281   },
282   "credits": {
283     "credit_type_id": "string",
284     "credit_type": {
285       "reference": "string",
286       "name": "string",
287       "object_type": "string",
288       "id": "string",
289       "status": "DRAFT",
290       "description": "string",
291       "unit_name": {
292         "singular": "string",
293         "plural": "string"
294       },
295       "created_at": "string",
296       "updated_at": "string"
297     }
298   },
299   "meter_value_calculation": {
300     "reference": "string",
301     "object_type": "string",
302     "id": "string",
303     "name": "string",
304     "description": "string",
305     "calculation_type": "SUM",
306     "persist": true,
307     "meter_id": "string",
308     "meter": {
309       "reference": "string",
310       "object_type": "string",
311       "id": "string",
312       "name": "string",
313       "description": "string",
314       "status": "DRAFT",
315       "meter_values": [
316         {
317           "id": "string",
318           "object": {
319             "reference": "string",
320             "object_type": "string",
321             "id": "string",
322             "name": "string",
323             "description": "string",
324             "status": "DRAFT",
325             "type": "NUMBER"
326           },
327           "required": true
328         }
329       ],
330       "meter_properties": [
331         {
332           "id": "string",
333           "object": {
334             "reference": "string",
335             "status": "DRAFT",
336             "object_type": "string",
337             "id": "string",
338             "name": "string",
339             "description": "string",
340             "type": "NUMBER",
341             "enum_values": [
342               "string"
343             ]
344           },
345           "required": true
346         }
347       ]
348     },
349     "meter_value_id": "string",
350     "meter_value": {
351       "reference": "string",
352       "object_type": "string",
353       "id": "string",
354       "name": "string",
355       "description": "string",
356       "status": "DRAFT",
357       "type": "NUMBER"
358     },
359     "meter_property_id": "string",
360     "meter_property": {
361       "reference": "string",
362       "status": "DRAFT",
363       "object_type": "string",
364       "id": "string",
365       "name": "string",
366       "description": "string",
367       "type": "NUMBER",
368       "enum_values": [
369         "string"
370       ]
371     }
372   },
373   "tax_category": "STANDARD",
374   "display_order": 1,
375   "unit_name": {
376     "singular": "string",
377     "plural": "string"
378   },
379   "custom_fields": [
380     {
381       "id": "string",
382       "reference": "string",
383       "value": "string",
384       "values": [
385         "string"
386       ],
387       "integration_details": {
388         "payment_gateway_variant": "ADYEN",
389         "id": "string",
390         "reference": "string",
391         "adyen": {
392           "recurring_detail_reference": "string"
393         },
394         "stripe": {
395           "payment_method_id": "string"
396         }
397       }
398     }
399   ],
400   "meter_value_calculation_id": "string",
401   "report_meter_value_calculation_ids": [
402     "string"
403   ]
404 }

Requires the PRODUCT_ITEM.CREATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

product_idstring or nullOptional

The resource ID of the product, that belongs to the product item.

productobject or nullOptional

namestring or nullOptionalformat: "^.*$"0-256 characters

descriptionstring or nullOptionalformat: "^.*$"0-256 characters

typeenum or nullOptional

The type of the product item.

Allowed values:

model_typeenum or nullOptional

usage_basedobjectOptional

Additional settings in case of a USAGE_BASED type.

creditsobjectOptional

Additional settings in case of a CREDITS type.

meter_value_calculationobject or nullOptional

tax_categoryenum or nullOptional

The default tax category applied to the product item.

Allowed values:

display_orderinteger or nullOptional

unit_nameobjectOptional

custom_fieldslist of objects or nullOptional

Custom fields associated to this product item

meter_value_calculation_idstring or nullOptionalDeprecated

The linked meter value calculation, in case of a USAGE_BASED charge type.

report_meter_value_calculation_idslist of strings or nullOptionalDeprecated

Optional reporting meter value calculations, in case of a USAGE_BASED charge type.

Response

Created

referencestringformat: "^\S+$"0-256 characters

object_typestring or nullRead-only

idstring or nullRead-only

product_idstring or null

The resource ID of the product, that belongs to the product item.

productobject or null

namestring or nullformat: "^.*$"0-256 characters

statusenum or nullRead-only

Allowed values:

descriptionstring or nullformat: "^.*$"0-256 characters

typeenum or null

The type of the product item.

Allowed values:

model_typeenum or null

usage_basedobject

Additional settings in case of a USAGE_BASED type.

creditsobject

Additional settings in case of a CREDITS type.

meter_value_calculationobject or null

tax_categoryenum or null

The default tax category applied to the product item.

Allowed values:

display_orderinteger or null

unit_nameobject

custom_fieldslist of objects or null

Custom fields associated to this product item

meter_value_calculation_idstring or nullDeprecated

The linked meter value calculation, in case of a USAGE_BASED charge type.

report_meter_value_calculation_idslist of strings or nullDeprecated

Optional reporting meter value calculations, in case of a USAGE_BASED charge type.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors