Updating an item

Companies can update their existing items by submitting a PATCH request to the Loop API.

The itemId is used as the unique identifier so it must be supplied correctly in order to update a specific item. Fields that are read only and cannot be updated via the API are: id, createdAt, updatedAt.

You can use the GET endpoint to get the item's details, copy/paste the response into the body of the PATCH and change the values you want to update.

patch

Authorizations

Header parameters

entity-idstringrequired

Body

namestringoptional

The name of the item

Example: The Professional Plan

amountnumber · doubleoptional

The amount of the item, denoted in USD. Setting the value to 0 means the item's price is variable rate, and the price will be displayed as "Price varies" on the checkout page

Example: 29.99

frequencystringoptional

The frequency with which to charge the item. Valid values: [HOUR, DAY, WEEK, MONTH, YEAR]

Example: WEEK

frequencyCountnumber · doubleoptional

The frequency count with which to charge the item. Used in combination with frequency e.g. every 2 weeks, every 1 month. A frequency count of 0 denotes a one time payment

Example: 2

acceptedTokensobjectoptional

A hash where the keys are the networkIds and the values are arrays of token addresses for each of the network (see example below). The token addresses will be a subset of the initial tokens accepted as payment specified per network. If omitted, the full list of tokens will be used that was defined when the contract was deployed to a particular network

entityIdstringoptional

The ID of the entity. Found on your company dashboard

Example: 4d1f3191-935b-40c5-b91e-37e1e3700bac

externalIdstringoptional

External subscription ID if applicable. E.g Stripe Subscription ID

Example: orbf9e15-e54b-11ec-b21b-06d24995f946

activebooleanoptional

True means agreements can still be made with this item.

Example: true

priceMetadatastringoptional

Optional details related to the payment amount displayed in the cart on the hosted payment page

Example: Increases to $200 after 2 weeks

typeIdnumber · doubleoptional

Classification of the item. See the GET call to get the most current list

Example: 1

categoryIdnumber · doubleoptional

The merchant category code (also known as an MCC) ID

Example: 10

autoInvoicebooleanoptional

Defaults to false. If true, then invoices will be automatically generated via the auto-invoicing feature. Delegated signing must be turned on for the entity and an inbound treasury wallet. Please contact Loop ([e-mail]) to have these enabled

Example: false

initialOffsetnumber · doubleoptional

Specified in days. Says when the first invoice should be created relative to the date/time of the Item's creation

Example: 1

itemIdstringrequired

The external ID of the item

Example: 2a697faf-8fdb-4aab-be20-64db0cef7dd5

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.loopcrypto.xyz/api/v1/items' \
  --header 'api-key: YOUR_API_KEY' \
  --header 'entity-id: text' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "name": "The Professional Plan",
      "amount": 29.99,
      "frequency": "WEEK",
      "frequencyCount": 2,
      "acceptedTokens": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "entityId": "4d1f3191-935b-40c5-b91e-37e1e3700bac",
      "externalId": "orbf9e15-e54b-11ec-b21b-06d24995f946",
      "active": true,
      "priceMetadata": "Increases to $200 after 2 weeks",
      "typeId": "1",
      "categoryId": 10,
      "autoInvoice": false,
      "initialOffset": 1,
      "itemId": "2a697faf-8fdb-4aab-be20-64db0cef7dd5"
    }
  ]'

200

400

401

403

422

500

504

200

{
  "items": [
    {
      "name": "The Professional Plan",
      "amount": 29.99,
      "frequency": "MONTH",
      "frequencyCount": 1,
      "acceptedTokens": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "externalId": "price_1ObTC0EsKlmFX3FHDjZnmim1",
      "active": true,
      "priceMetadata": "Increases to $200 after 2 weeks",
      "autoInvoice": true,
      "initialOffset": 1,
      "itemId": "2a697faf-8fdb-4aab-be20-64db0cef7dd5",
      "entityId": "4d1f3191-935b-40c5-b91e-37e1e3700bac",
      "url": "https://checkout.loopcrypto.xyz/4d1f3191-935b-40c5-b91e-37e1e3700bac/2a697faf-8fdb-4aab-be20-64db0cef7dd5",
      "type": "Subscription",
      "category": "Books, Periodicals, and Newspapers",
      "categoryCode": 5192
    }
  ]
}

Ok