v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Subscription items

Update a subscription item

Updates an item of a subscription. Pass quantity to change the number of units, and price_data to replace the item's price with a newly created one. When the subscription has other items, the new price must use a currency compatible with theirs (a CLF price bills within a CLP subscription) and the same recurring interval. You can replace the price of a subscription's only item with any currency. Changes take effect on the subscription's next invoice, with no proration for the current billing period.

patch/subscriptions/{subscription_id}/items/{id}

Path parameters

subscription_idstring required

The id of the subscription the item belongs to.

idstring required

The id of the subscription item to update.

Request body

quantityinteger

Number of units of the price the item bills for. Must be greater than zero.

Example request

{
  "price_data": {
    "currency": "CLP",
    "recurring": {
      "interval": "month",
      "interval_count": 1
    },
    "unit_amount": 9000,
    "product": "prod_2c4mDgwQqkNwMHnXSc4DBjkbcWz",
    "product_data": {
      "name": "Updated seat",
      "description": "An additional seat for the workspace.",
      "image_url": "https://example.com/image.png",
      "metadata": {
        "category": "saas"
      }
    }
  },
  "quantity": 3
}

Response

The updated subscription item.

idstring required

Unique identifier of the subscription item.

object'subscription_item' required

Type of the object. Always subscription_item.

quantityinteger required

Number of units of the price the item bills for.

Example response

{
  "id": "si_2c4mDfkPLLrLTCJ3wPCEHGYpkVf",
  "price": {
    "currency": "CLP",
    "product": {
      "id": "prod_2c4mDgwQqkNwMHnXSc4DBjkbcWz",
      "created_at": "2026-06-01T15:00:00Z",
      "description": "Access to every premium feature.",
      "image_url": "https://example.com/image.png",
      "metadata": {
        "category": "saas"
      },
      "mode": "live",
      "name": "Premium plan"
    },
    "recurring": {
      "interval": "month",
      "interval_count": 1
    },
    "unit_amount": 10000
  },
  "quantity": 1
}