Skip to main content
PUT
/
memberships
/
cp
/
api
/
subscription-contract-details
Update subscription contract details
curl --request PUT \
  --url https://www.myshop.com/apps/memberships/cp/api/subscription-contract-details \
  --header 'Content-Type: application/json' \
  --data '
{
  "shop": "<string>"
}
'
import requests

url = "https://www.myshop.com/apps/memberships/cp/api/subscription-contract-details"

payload = { "shop": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({shop: '<string>'})
};

fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-contract-details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/memberships/cp/api/subscription-contract-details';
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({shop: '<string>'})
};

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/memberships/cp/api/subscription-contract-details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'shop' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://www.myshop.com/apps/memberships/cp/api/subscription-contract-details"

payload := strings.NewReader("{\n \"shop\": \"<string>\"\n}")

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

req.Header.Add("Content-Type", "application/json")

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/memberships/cp/api/subscription-contract-details")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"shop\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "shop": "<string>",
  "activatedOn": "2023-11-07T05:31:56Z",
  "allowDeliveryPriceOverride": true,
  "autoCharge": true,
  "billingDateAfterTrial": "2023-11-07T05:31:56Z",
  "billingPolicyInterval": "<string>",
  "billingPolicyIntervalCount": 123,
  "cancellationFeedback": "<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>",
  "deliveryPolicyInterval": "<string>",
  "deliveryPolicyIntervalCount": 123,
  "dunning": true,
  "emailBouncedOrFailed": true,
  "endsAt": "2023-11-07T05:31:56Z",
  "graphCustomerId": "<string>",
  "graphOrderId": "<string>",
  "graphSubscriptionContractId": "<string>",
  "id": 123,
  "importedId": "<string>",
  "maxCycles": 123,
  "minCycles": 123,
  "nextBillingDate": "2023-11-07T05:31:56Z",
  "orderAmount": 123,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "<string>",
  "orderNote": "<string>",
  "orderNoteAttributes": "<string>",
  "pausedBySecurityChallenge": true,
  "pausedFromActive": true,
  "pausedOn": "2023-11-07T05:31:56Z",
  "phone": "<string>",
  "startsAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "stopUpComingOrderEmail": true,
  "subscriptionContractId": 123,
  "subscriptionCreatedEmailSent": true,
  "trialEndDate": "2023-11-07T05:31:56Z",
  "upcomingSwapRule": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
shop
string
required
activatedOn
string<date-time>
allowDeliveryPriceOverride
boolean
autoCharge
boolean
billingDateAfterTrial
string<date-time>
billingPolicyInterval
string
billingPolicyIntervalCount
integer<int32>
cancellationFeedback
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
deliveryPolicyInterval
string
deliveryPolicyIntervalCount
integer<int32>
dunning
boolean
emailBouncedOrFailed
boolean
endsAt
string<date-time>
graphCustomerId
string
graphOrderId
string
graphSubscriptionContractId
string
id
integer<int64>
importedId
string
maxCycles
integer<int32>
minCycles
integer<int32>
nextBillingDate
string<date-time>
orderAmount
number<double>
orderAmountUSD
number<double>
orderId
integer<int64>
orderName
string
orderNote
string
orderNoteAttributes
string
pausedBySecurityChallenge
boolean
pausedFromActive
boolean
pausedOn
string<date-time>
phone
string
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
trialEndDate
string<date-time>
upcomingSwapRule
string
updatedAt
string<date-time>

Response

200 - */*

OK

shop
string
required
activatedOn
string<date-time>
allowDeliveryPriceOverride
boolean
autoCharge
boolean
billingDateAfterTrial
string<date-time>
billingPolicyInterval
string
billingPolicyIntervalCount
integer<int32>
cancellationFeedback
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
deliveryPolicyInterval
string
deliveryPolicyIntervalCount
integer<int32>
dunning
boolean
emailBouncedOrFailed
boolean
endsAt
string<date-time>
graphCustomerId
string
graphOrderId
string
graphSubscriptionContractId
string
id
integer<int64>
importedId
string
maxCycles
integer<int32>
minCycles
integer<int32>
nextBillingDate
string<date-time>
orderAmount
number<double>
orderAmountUSD
number<double>
orderId
integer<int64>
orderName
string
orderNote
string
orderNoteAttributes
string
pausedBySecurityChallenge
boolean
pausedFromActive
boolean
pausedOn
string<date-time>
phone
string
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
trialEndDate
string<date-time>
upcomingSwapRule
string
updatedAt
string<date-time>