v1

latestOpenAPI 3.0.02026-07-14311851.4 KB
Subscription Group

Update Subscription by groupId

Updates a Subscription by groupId.

patch/subscriptions-group/{groupId}

Path parameters

groupIdstring required
Example:1

Group ID.

Request body

isSkippedboolean required
statusstring required

Example request

{
  "isSkipped": true,
  "item": [
    {
      "SubscriptionId": "string",
      "createdAt": "2019-06-20T18:27:41.23Z",
      "cycleCount": 0,
      "endpoint": "string",
      "isSkipped": true,
      "lastUpdate": "2019-06-20T18:27:41.23Z",
      "metadata": [
        {
          "name": "string",
          "properties": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ],
      "originalItemIndex": 0,
      "originalOrderId": "string",
      "priceAtSubscriptionDate": 0,
      "quantity": 0,
      "sellingPrice": 0,
      "sku": {
        "detailUrl": "string",
        "id": "string",
        "imageUrl": "string",
        "name": "string",
        "nameComplete": "string",
        "productName": "string"
      },
      "status": "ACTIVE"
    }
  ],
  "metadata": [
    {
      "name": "string",
      "properties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "plan": {
    "frequency": {
      "interval": 0,
      "periodicity": "string"
    },
    "type": "string",
    "validity": {
      "begin": "2019-06-20T18:27:41.23Z",
      "end": "2019-06-20T18:27:41.23Z"
    }
  },
  "purchaseSettings": {
    "currencyCode": "string",
    "paymentMethod": {
      "paymentAccountId": "string",
      "paymentSystem": "string"
    },
    "purchaseDay": "string",
    "salesChannel": "string",
    "selectedSla": "string",
    "seller": "string"
  },
  "shippingAddress": {
    "additionalComponents": [
      {
        "longName": "string",
        "shortName": "string",
        "types": [
          "string"
        ]
      }
    ],
    "addressId": "string",
    "addressName": "string",
    "addressType": "string",
    "city": "string",
    "complement": "string",
    "country": "string",
    "formattedAddress": "string",
    "geoCoordinate": [
      0
    ],
    "neighborhood": "string",
    "number": "string",
    "postalCode": "string",
    "receiverName": "string",
    "reference": "string",
    "state": "string",
    "street": "string"
  },
  "status": "string"
}

Response

OK