Archive a product item

POST

/v:version/product-items/:resourceIdOrReference/archive

POST

/v:version/product-items/:resourceIdOrReference/archive

1 curl -X POST https://test.api.solvimon.com/v1/product-items//archive \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "reference": "WH-2024-BLK",
3   "object_type": "product_item",
4   "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
5   "product_id": "p1234567890abcdef",
6   "product": {
7     "category_id": "cat9876543210fedcba",
8     "name": "Wireless Headphones",
9     "reference": "WH-2024",
10     "product_type": "DEFAULT",
11     "object_type": "product",
12     "id": "p1234567890abcdef",
13     "category": {
14       "name": "Electronics",
15       "reference": "ELEC-001",
16       "object_type": "category",
17       "id": "cat9876543210fedcba",
18       "description": "Category for electronic devices and accessories",
19       "tax_category": "STANDARD",
20       "display_order": 10
21     },
22     "parent_product_id": "p0987654321fedcba",
23     "description": "High-quality wireless headphones with noise cancellation",
24     "status": "DRAFT",
25     "tax_category": "STANDARD",
26     "features": [
27       {
28         "reference": "Bluetooth 5.0",
29         "id": "feat1234abcd5678ef"
30       }
31     ],
32     "custom_fields": [
33       {
34         "id": "cf1234567890abcd",
35         "reference": "color",
36         "value": "black",
37         "values": [
38           "black",
39           "white",
40           "blue"
41         ],
42         "integration_details": {
43           "payment_gateway_variant": "ADYEN",
44           "id": "intg1234abcd5678ef",
45           "reference": "stripe_integration",
46           "adyen": {
47             "recurring_detail_reference": "recurring_001"
48           },
49           "stripe": {
50             "payment_method_id": "pm_1GqIC8Lz0qyl6XeWzXxYz123"
51           }
52         }
53       }
54     ],
55     "display_order": 5,
56     "linked_integrations": [
57       {
58         "id": "link1234abcd5678ef",
59         "link_details": [
60           {
61             "url": "https://example.com/product/wh-2024",
62             "custom_field_name": "product_page"
63           }
64         ]
65       }
66     ],
67     "billing_entity_id": "be1234567890abcd"
68   },
69   "name": "Wireless Headphones - Black",
70   "status": "DRAFT",
71   "description": "Wireless headphones in black color with premium sound quality",
72   "type": "REVENUE",
73   "model_type": "USAGE_BASED",
74   "usage_based": {
75     "meter_value_calculation_id": "mvc1234567890abcd",
76     "meter_value_calculation": {
77       "reference": "sum_listening_hours",
78       "object_type": "meter_value_calculation",
79       "id": "mvc1234567890abcd",
80       "name": "Sum Listening Hours",
81       "description": "Calculates total listening hours for usage billing",
82       "calculation_type": "SUM",
83       "persist": true,
84       "meter_id": "meter1234567890abcd",
85       "meter": {
86         "reference": "listening_hours_meter",
87         "object_type": "meter",
88         "id": "meter1234567890abcd",
89         "name": "Listening Hours Meter",
90         "description": "Tracks hours of headphone usage",
91         "status": "DRAFT",
92         "meter_values": [
93           {
94             "id": "mv1234567890abcd",
95             "object": {
96               "reference": "hours_used",
97               "object_type": "meter_value",
98               "id": "mv1234567890abcd",
99               "name": "Hours Used",
100               "description": "Number of hours headphones were used",
101               "status": "DRAFT",
102               "type": "NUMBER"
103             },
104             "required": true
105           }
106         ],
107         "meter_properties": [
108           {
109             "id": "mp1234567890abcd",
110             "object": {
111               "reference": "usage_type",
112               "status": "DRAFT",
113               "object_type": "meter_property",
114               "id": "mp1234567890abcd",
115               "name": "Usage Type",
116               "description": "Type of usage recorded",
117               "type": "NUMBER",
118               "enum_values": [
119                 "streaming",
120                 "offline"
121               ]
122             },
123             "required": true
124           }
125         ]
126       },
127       "meter_value_id": "mv1234567890abcd",
128       "meter_value": {
129         "reference": "hours_used",
130         "object_type": "meter_value",
131         "id": "mv1234567890abcd",
132         "name": "Hours Used",
133         "description": "Number of hours headphones were used",
134         "status": "DRAFT",
135         "type": "NUMBER"
136       },
137       "meter_property_id": "mp1234567890abcd",
138       "meter_property": {
139         "reference": "usage_type",
140         "status": "DRAFT",
141         "object_type": "meter_property",
142         "id": "mp1234567890abcd",
143         "name": "Usage Type",
144         "description": "Type of usage recorded",
145         "type": "NUMBER",
146         "enum_values": [
147           "streaming",
148           "offline"
149         ]
150       }
151     },
152     "tiering_meter_value_calculation_id": "tiermvc1234567890",
153     "tiering_meter_value_calculation": {
154       "reference": "tiered_listening_hours",
155       "object_type": "meter_value_calculation",
156       "id": "tiermvc1234567890",
157       "name": "Tiered Listening Hours",
158       "description": "Calculates tiered usage for billing",
159       "calculation_type": "SUM",
160       "persist": true,
161       "meter_id": "tier_meter1234567890",
162       "meter": {
163         "reference": "tiered_listening_hours_meter",
164         "object_type": "meter",
165         "id": "tier_meter1234567890",
166         "name": "Tiered Listening Hours Meter",
167         "description": "Tracks tiered hours of headphone usage",
168         "status": "DRAFT",
169         "meter_values": [
170           {
171             "id": "tier_mv1234567890",
172             "object": {
173               "reference": "tier_hours_used",
174               "object_type": "meter_value",
175               "id": "tier_mv1234567890",
176               "name": "Tier Hours Used",
177               "description": "Number of hours used in tiered billing",
178               "status": "DRAFT",
179               "type": "NUMBER"
180             },
181             "required": true
182           }
183         ],
184         "meter_properties": [
185           {
186             "id": "tier_mp1234567890",
187             "object": {
188               "reference": "tier_level",
189               "status": "DRAFT",
190               "object_type": "meter_property",
191               "id": "tier_mp1234567890",
192               "name": "Tier Level",
193               "description": "Billing tier level",
194               "type": "NUMBER",
195               "enum_values": [
196                 "basic",
197                 "premium",
198                 "enterprise"
199               ]
200             },
201             "required": true
202           }
203         ]
204       },
205       "meter_value_id": "tier_mv1234567890",
206       "meter_value": {
207         "reference": "tier_hours_used",
208         "object_type": "meter_value",
209         "id": "tier_mv1234567890",
210         "name": "Tier Hours Used",
211         "description": "Number of hours used in tiered billing",
212         "status": "DRAFT",
213         "type": "NUMBER"
214       },
215       "meter_property_id": "tier_mp1234567890",
216       "meter_property": {
217         "reference": "tier_level",
218         "status": "DRAFT",
219         "object_type": "meter_property",
220         "id": "tier_mp1234567890",
221         "name": "Tier Level",
222         "description": "Billing tier level",
223         "type": "NUMBER",
224         "enum_values": [
225           "basic",
226           "premium",
227           "enterprise"
228         ]
229       }
230     },
231     "report_meter_value_calculation_ids": [
232       "mvc1234567890abcd",
233       "tiermvc1234567890"
234     ],
235     "conditions": {
236       "name": "Usage Conditions",
237       "expression": {
238         "operator": "AND",
239         "operands": [
240           {
241             "meter_property": {
242               "comparator": "EQUALS",
243               "id": "cond_mp1234567890",
244               "reference": "usage_type",
245               "meter_property": {
246                 "reference": "usage_type",
247                 "status": "DRAFT",
248                 "object_type": "meter_property",
249                 "id": "cond_mp1234567890",
250                 "name": "Usage Type",
251                 "description": "Type of usage recorded",
252                 "type": "NUMBER",
253                 "enum_values": [
254                   "streaming",
255                   "offline"
256                 ]
257               },
258               "value": "streaming",
259               "values": [
260                 "streaming"
261               ]
262             },
263             "expression": {}
264           }
265         ]
266       },
267       "meter_properties": [
268         {
269           "comparator": "EQUALS",
270           "id": "cond_mp1234567890",
271           "reference": "usage_type",
272           "meter_property": {
273             "reference": "usage_type",
274             "status": "DRAFT",
275             "object_type": "meter_property",
276             "id": "cond_mp1234567890",
277             "name": "Usage Type",
278             "description": "Type of usage recorded",
279             "type": "NUMBER",
280             "enum_values": [
281               "streaming",
282               "offline"
283             ]
284           },
285           "value": "streaming",
286           "values": [
287             "streaming"
288           ]
289         }
290       ]
291     }
292   },
293   "credits": {
294     "credit_type_id": "credtype1234567890",
295     "credit_type": {
296       "reference": "headphone_credits",
297       "name": "Headphone Usage Credits",
298       "object_type": "credit_type",
299       "id": "credtype1234567890",
300       "status": "DRAFT",
301       "description": "Credits for headphone usage",
302       "unit_name": {
303         "singular": "credit",
304         "plural": "credits"
305       },
306       "created_at": "2023-11-01T09:00:00Z",
307       "updated_at": "2024-04-15T12:00:00Z"
308     }
309   },
310   "meter_value_calculation": {
311     "reference": "sum_listening_hours",
312     "object_type": "meter_value_calculation",
313     "id": "mvc1234567890abcd",
314     "name": "Sum Listening Hours",
315     "description": "Calculates total listening hours for usage billing",
316     "calculation_type": "SUM",
317     "persist": true,
318     "meter_id": "meter1234567890abcd",
319     "meter": {
320       "reference": "listening_hours_meter",
321       "object_type": "meter",
322       "id": "meter1234567890abcd",
323       "name": "Listening Hours Meter",
324       "description": "Tracks hours of headphone usage",
325       "status": "DRAFT",
326       "meter_values": [
327         {
328           "id": "mv1234567890abcd",
329           "object": {
330             "reference": "hours_used",
331             "object_type": "meter_value",
332             "id": "mv1234567890abcd",
333             "name": "Hours Used",
334             "description": "Number of hours headphones were used",
335             "status": "DRAFT",
336             "type": "NUMBER"
337           },
338           "required": true
339         }
340       ],
341       "meter_properties": [
342         {
343           "id": "mp1234567890abcd",
344           "object": {
345             "reference": "usage_type",
346             "status": "DRAFT",
347             "object_type": "meter_property",
348             "id": "mp1234567890abcd",
349             "name": "Usage Type",
350             "description": "Type of usage recorded",
351             "type": "NUMBER",
352             "enum_values": [
353               "streaming",
354               "offline"
355             ]
356           },
357           "required": true
358         }
359       ]
360     },
361     "meter_value_id": "mv1234567890abcd",
362     "meter_value": {
363       "reference": "hours_used",
364       "object_type": "meter_value",
365       "id": "mv1234567890abcd",
366       "name": "Hours Used",
367       "description": "Number of hours headphones were used",
368       "status": "DRAFT",
369       "type": "NUMBER"
370     },
371     "meter_property_id": "mp1234567890abcd",
372     "meter_property": {
373       "reference": "usage_type",
374       "status": "DRAFT",
375       "object_type": "meter_property",
376       "id": "mp1234567890abcd",
377       "name": "Usage Type",
378       "description": "Type of usage recorded",
379       "type": "NUMBER",
380       "enum_values": [
381         "streaming",
382         "offline"
383       ]
384     }
385   },
386   "tax_category": "STANDARD",
387   "display_order": 5,
388   "unit_name": {
389     "singular": "unit",
390     "plural": "units"
391   },
392   "custom_fields": [
393     {
394       "id": "cf1234567890abcd",
395       "reference": "color",
396       "value": "black",
397       "values": [
398         "black",
399         "white",
400         "blue"
401       ],
402       "integration_details": {
403         "payment_gateway_variant": "ADYEN",
404         "id": "intg1234abcd5678ef",
405         "reference": "stripe_integration",
406         "adyen": {
407           "recurring_detail_reference": "recurring_001"
408         },
409         "stripe": {
410           "payment_method_id": "pm_1GqIC8Lz0qyl6XeWzXxYz123"
411         }
412       }
413     }
414   ],
415   "meter_value_calculation_id": "mvc1234567890abcd",
416   "report_meter_value_calculation_ids": [
417     "mvc1234567890abcd"
418   ]
419 }

Requires the PRODUCT_ITEM.ARCHIVE 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

resourceIdOrReferencestringRequiredDefaults to

The ID or reference of the resource.

Response

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

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors