---
title: "Update Subscription by groupId"
method: PATCH
path: "/subscriptions-group/{groupId}"
tags: ["Subscription Group"]
---

# Update Subscription by groupId

`PATCH /subscriptions-group/{groupId}`

Updates a Subscription by `groupId`.

## Path parameters

- `groupId` string, required

## Request body

- UpdateSubscriptionbygroupIdRequest
  - `isSkipped` boolean, required
  - `item` Item1[], required
    - `SubscriptionId` string, required
    - `createdAt` string, required
    - `cycleCount` integer, required
    - `endpoint` string, required
    - `isSkipped` boolean, required
    - `lastUpdate` string, required
    - `metadata` Metadatum[], required
      - `name` string, required
      - `properties` Properties, required
        - `additionalProp1` string, required
        - `additionalProp2` string, required
        - `additionalProp3` string, required
    - `originalItemIndex` integer, required
    - `originalOrderId` string, required
    - `priceAtSubscriptionDate` integer, required
    - `quantity` integer, required
    - `sellingPrice` integer, required
    - `sku` Sku, required
      - `detailUrl` string, required
      - `id` string, required
      - `imageUrl` string, required
      - `name` string, required
      - `nameComplete` string, required
      - `productName` string, required
    - `status` string, required
  - `metadata` Metadatum[], required
    - `name` string, required
    - `properties` Properties, required
      - `additionalProp1` string, required
      - `additionalProp2` string, required
      - `additionalProp3` string, required
  - `plan` Plan, required
    - `frequency` Frequency, required
      - `interval` integer, required
      - `periodicity` string, required
    - `type` string, required
    - `validity` Validity, required
      - `begin` string, required
      - `end` string, required
  - `purchaseSettings` PurchaseSettings, required
    - `currencyCode` string, required
    - `paymentMethod` PaymentMethod, required
      - `paymentAccountId` string, required
      - `paymentSystem` string, required
    - `purchaseDay` string, required
    - `salesChannel` string, required
    - `selectedSla` string, required
    - `seller` string, required
  - `shippingAddress` ShippingAddress, required
    - `additionalComponents` AdditionalComponent[], required
      - `longName` string, required
      - `shortName` string, required
      - `types` string[], required
    - `addressId` string, required
    - `addressName` string, required
    - `addressType` string, required
    - `city` string, required
    - `complement` string, required
    - `country` string, required
    - `formattedAddress` string, required
    - `geoCoordinate` integer[], required
    - `neighborhood` string, required
    - `number` string, required
    - `postalCode` string, required
    - `receiverName` string, required
    - `reference` string, required
    - `state` string, required
    - `street` string, required
  - `status` string, required

## Response `200`

OK

---

[API](https://skmtc.net/vtex/apis/subscriptions-api-v2.md) · [All operations](https://skmtc.net/vtex/apis/subscriptions-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/subscriptions-api-v2/versions/4a53e5077f30/schema)