Update, add or alter information of a given Subscription, filtering by subscriptionId
.
The object has the following properties:
Attribute | Type | Description |
---|---|---|
item | object | |
id | string | |
name | string | |
productName | string | |
imageUrl | string | |
nameComplete | string | |
quantity | integer | |
priceAtSubscriptionDate | integer | |
SellingPrice | integer | |
endpoint | string | |
plan | object | |
frequency | object | |
periodicity | string | |
interval | integer | |
validity | object | |
begin | string | |
end | string | |
type | string | |
purchaseSettings | object | |
purchaseDay | string | |
paymentMethod | object | |
paymentSystem | string | |
paymentAccountId | string | |
seller | string | |
salesChannel | string | |
selectedSla | string | |
currencyCode | string | |
shippingAddress | object | |
addressId | string | |
number | string | |
complement | string | |
neighborhood | string | |
city | string | |
state | string | |
country | string | |
postalCode | string | |
reference | string | |
formattedAddress | string | |
additionalComponents | array | |
longName | string | |
shortName | string | |
types | array | |
geoCoordinate | array | |
receiverName | string | |
addressType | string | |
addressName | string | |
status | string | |
isSkipped | boolean | |
metadata | array | |
name | string | |
properties | object | |
additionalProp1 | string | |
additionalProp2 | string | |
additionalProp3 | string |
Request body example
curl --location --request PATCH 'https://{{accountName}}.{{environment}}.com.br/api/rns/subscriptions/{{subscriptionId}}' \
--header 'Content-Type: application/json' \
--header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \
--header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' \
--data-raw '{
"item": {
"sku": {
"id": "string",
"name": "string",
"productName": "string",
"imageUrl": "string",
"detailUrl": "string",
"nameComplete": "string"
},
"quantity": 0,
"priceAtSubscriptionDate": 0,
"sellingPrice": 0,
"endpoint": "string"
},
"plan": {
"frequency": {
"periodicity": "string",
"interval": 0
},
"validity": {
"begin": "2019-07-04T14:40:30.819Z",
"end": "2019-07-04T14:40:30.819Z"
},
"type": "string"
},
"purchaseSettings": {
"purchaseDay": "string",
"paymentMethod": {
"paymentSystem": "string",
"paymentAccountId": "string"
},
"seller": "string",
"salesChannel": "string",
"selectedSla": "string",
"currencyCode": "string"
},
"shippingAddress": {
"addressId": "string",
"street": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"reference": "string",
"formattedAddress": "string",
"additionalComponents": [
{
"longName": "string",
"shortName": "string",
"types": [
"string"
]
}
],
"geoCoordinate": [
0
],
"receiverName": "string",
"addressType": "string",
"addressName": "string"
},
"status": "string",
"isSkipped": true,
"metadata": [
{
"name": "string",
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
]
}'