PUT
/
items
/
{item_id}
curl --request PUT \
  --url https://api.withorb.com/v1/items/{item_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {},
  "name": "<string>",
  "external_connections": [
    {
      "external_connection_name": "stripe",
      "external_entity_id": "<string>"
    }
  ]
}'
{
  "metadata": {},
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "external_connections": [
    {
      "external_connection_name": "stripe",
      "external_entity_id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
item_id
string
required

Body

application/json

A list of external connections to map an item to. Note that passing null will clear existing mappings. Orb requires that you pass the full list of mappings; this list will replace the existing item mappings.

Response

200
application/json
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.