Skip to main content
PUT
/
subscriptions
/
cp
/
api
/
update-contract-order-note
/
{contractId}
Update subscription contract order note
curl --request PUT \
  --url https://www.myshop.com/apps/subscriptions/cp/api/update-contract-order-note/{contractId}
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/update-contract-order-note/{contractId}"

response = requests.put(url)

print(response.text)
const options = {method: 'PUT'};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/update-contract-order-note/{contractId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/subscriptions/cp/api/update-contract-order-note/{contractId}';
const options = {method: 'PUT'};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/update-contract-order-note/{contractId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://www.myshop.com/apps/subscriptions/cp/api/update-contract-order-note/{contractId}"

req, _ := http.NewRequest("PUT", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://www.myshop.com/apps/subscriptions/cp/api/update-contract-order-note/{contractId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
{
  "shop": "<string>",
  "activatedOn": "2023-11-07T05:31:56Z",
  "allowDeliveryAddressOverride": true,
  "allowDeliveryPriceOverride": true,
  "autoCharge": true,
  "billingCountryCode": "<string>",
  "billingDateAfterTrial": "2023-11-07T05:31:56Z",
  "billingPolicyInterval": "<string>",
  "billingPolicyIntervalCount": 123,
  "cancellationFeedback": "<string>",
  "cancellationNote": "<string>",
  "cancelledOn": "2023-11-07T05:31:56Z",
  "contractAmount": 123,
  "contractAmountUSD": 123,
  "contractDetailsJSON": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "currencyCode": "<string>",
  "customerEmail": "<string>",
  "customerFirstName": "<string>",
  "customerId": 123,
  "customerLastName": "<string>",
  "customerName": "<string>",
  "customerTag": "<string>",
  "deletedVariantIds": "<string>",
  "deliveryCountryCode": "<string>",
  "deliveryPolicyInterval": "<string>",
  "deliveryPolicyIntervalCount": 123,
  "disableFixEmptyQueue": true,
  "emailBouncedOrFailed": true,
  "endsAt": "2023-11-07T05:31:56Z",
  "graphCustomerId": "<string>",
  "graphOrderId": "<string>",
  "graphSubscriptionContractId": "<string>",
  "id": 123,
  "importedId": "<string>",
  "lastSuccessfulOrder": "<string>",
  "lifetimeValue": 123,
  "lifetimeValueUSD": 123,
  "maxCycles": 123,
  "minCycles": 123,
  "nextBillingDate": "2023-11-07T05:31:56Z",
  "nextPaidBillingDate": "2023-11-07T05:31:56Z",
  "orderAmount": 123,
  "orderAmountContractCurrency": 123,
  "orderAmountShopCurrency": 123,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "<string>",
  "orderNote": "<string>",
  "orderNoteAttributes": "<string>",
  "originalContractId": 123,
  "pauseDurationCycle": 123,
  "pauseFeedback": "<string>",
  "pauseReason": "<string>",
  "pauseTillDate": "2023-11-07T05:31:56Z",
  "pausedFromActive": true,
  "pausedOn": "2023-11-07T05:31:56Z",
  "pendingCancellationCycle": 123,
  "pendingCancellationDate": "2023-11-07T05:31:56Z",
  "phone": "<string>",
  "queueUpdatedAt": "2023-11-07T05:31:56Z",
  "skipPaymentCreateUnpaidOrder": true,
  "startsAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "stopUpComingOrderEmail": true,
  "subscriptionContractId": 123,
  "subscriptionCreatedEmailSent": true,
  "subscriptionTypeIdentifier": "<string>",
  "totalSuccessfulOrders": 123,
  "upcomingEmailBufferDays": 123,
  "upcomingEmailTaskUrl": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatingQueue": true
}

Path Parameters

contractId
integer<int64>
required

Query Parameters

orderNote
string
required

Response

200 - */*

OK

shop
string
required
activatedOn
string<date-time>
allowDeliveryAddressOverride
boolean
allowDeliveryPriceOverride
boolean
autoCharge
boolean
billingCountryCode
string
billingDateAfterTrial
string<date-time>
billingPolicyInterval
string
billingPolicyIntervalCount
integer<int32>
cancellationFeedback
string
cancellationNote
string
cancelledOn
string<date-time>
contractAmount
number<double>
contractAmountUSD
number<double>
contractDetailsJSON
string
createdAt
string<date-time>
currencyCode
string
customerEmail
string
customerFirstName
string
customerId
integer<int64>
customerLastName
string
customerName
string
customerTag
string
deletedVariantIds
string
deliveryCountryCode
string
deliveryPolicyInterval
string
deliveryPolicyIntervalCount
integer<int32>
disableFixEmptyQueue
boolean
emailBouncedOrFailed
boolean
endsAt
string<date-time>
graphCustomerId
string
graphOrderId
string
graphSubscriptionContractId
string
id
integer<int64>
importedId
string
lastSuccessfulOrder
string
lifetimeValue
number<double>
lifetimeValueUSD
number<double>
maxCycles
integer<int32>
minCycles
integer<int32>
nextBillingDate
string<date-time>
nextPaidBillingDate
string<date-time>
orderAmount
number<double>
orderAmountContractCurrency
number<double>
orderAmountShopCurrency
number<double>
orderAmountUSD
number<double>
orderId
integer<int64>
orderName
string
orderNote
string
orderNoteAttributes
string
originType
enum<string>
Available options:
STORE_FRONT,
IMPORTED,
SPLIT_ATTEMPT_BILLING,
SPLIT_CONTRACT
originalContractId
integer<int64>
pauseDurationCycle
integer<int32>
pauseFeedback
string
pauseReason
string
pauseTillDate
string<date-time>
pausedFromActive
boolean
pausedOn
string<date-time>
pendingCancellationCycle
integer<int32>
pendingCancellationDate
string<date-time>
phone
string
queueUpdatedAt
string<date-time>
skipPaymentCreateUnpaidOrder
boolean
startsAt
string<date-time>
status
string
stopUpComingOrderEmail
boolean
subscriptionContractId
integer<int64>
subscriptionCreatedEmailSent
boolean
subscriptionCreatedEmailSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
EMAIL_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_PAUSED_STATUS
subscriptionCreatedSmsSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
SMS_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_PAUSED_STATUS,
PHONE_NUMBER_EMPTY
subscriptionType
enum<string>
Available options:
REGULAR_SUBSCRIPTION,
BUILD_A_BOX_CLASSIC,
BUILD_A_BOX_SINGLE_PRODUCT,
BUNDLING_CLASSIC,
BUNDLING_MIX_AND_MATCH,
SECTIONED_BUNDLE,
VOLUME_DISCOUNT
subscriptionTypeIdentifier
string
totalSuccessfulOrders
integer<int32>
upcomingEmailBufferDays
integer<int32>
upcomingEmailTaskUrl
string
updatedAt
string<date-time>
updatingQueue
boolean