Skip to main content
POST
/
items
/
{item_id}
/
archive
Archive item
curl --request POST \
  --url https://api.withorb.com/v1/items/{item_id}/archive \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {},
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "external_connections": [
    {
      "external_connection_name": "stripe",
      "external_entity_id": "<string>"
    }
  ],
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
item_id
string
required

Response

OK

The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics, and prices and are used for defining external sync behavior for invoices and tax calculation purposes.

​
metadata
object
required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

​
id
string
required

The Orb-assigned unique identifier for the item.

​
name
string
required

The name of the item.

​
created_at
string<date-time>
required

The time at which the item was created.

​
external_connections
ItemExternalConnection · object[]
required

A list of external connections for this item, used to sync with external invoicing and tax systems.

​
archived_at
string<date-time> | null

The time at which the item was archived. If null, the item is not archived.

⌘I