Sign in

v1

latestOpenAPI 3.0.02026-07-14311851.4 KB
Subscriptions

Update Subscriptions by SubscriptionId

Update, add or alter information of a given Subscription, filtering by subscriptionId.

patch/subscriptions/{subscriptionId}

Path parameters

subscriptionIdstring required
Example:1

Subscription ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

isSkippedboolean required
statusstring required

Example request

{
  "isSkipped": true,
  "item": {
    "endpoint": "string",
    "priceAtSubscriptionDate": 0,
    "quantity": 0,
    "sellingPrice": 0,
    "sku": {
      "detailUrl": "string",
      "id": "string",
      "imageUrl": "string",
      "name": "string",
      "nameComplete": "string",
      "productName": "string"
    }
  },
  "metadata": [
    {
      "name": "string",
      "properties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "plan": {
    "frequency": {
      "interval": 0,
      "periodicity": "string"
    },
    "type": "string",
    "validity": {
      "begin": "2019-07-04T14:40:30.819Z",
      "end": "2019-07-04T14:40:30.819Z"
    }
  },
  "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