Update or create a product item (upsert)

PUT

/v:version/product-items

PUT

/v:version/product-items

$ curl -X PUT https://test.api.solvimon.com/v1/product-items \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "product_id": "string",
>   "name": "reimbursed_amount",
>   "reference": "reference",
>   "model_type": "USAGE_BASED"
> }'

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

Requires the PRODUCT_ITEM.CREATE or PRODUCT_ITEM.UPDATE 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

Query parameters

identifier_fieldstringOptional

Which field to use to identify whether the resource exists or not

custom_field_referencestringOptional

Which custom field to use to identify whether the resource exists or not

field_actionsmap from strings to stringsOptional

The list of actions for specific fields.

Request

This endpoint expects an object.

product_idstring or nullRequired

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

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

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

model_typeenum or nullRequired

productobject or nullOptional

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

typeenum or nullOptional

The type of the product item.

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.

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

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

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

statusenum or nullOptionalRead-only

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