Membership Contracts

Update membership contract status

Updates the status of an existing membership contract (ACTIVE, PAUSED, CANCELLED, or EXPIRED). This is one of the most critical operations for managing membership lifecycles.

Supported Status Values:

ACTIVE: Membership is active and will process recurring billing
PAUSED: Membership is temporarily paused, no billing will occur
CANCELLED: Membership is permanently cancelled, no future billing
EXPIRED: Membership has expired (typically used when max cycles reached)

Pause Duration:

When pausing, you can optionally specify pauseDurationCycle to auto-resume after N cycles
If not specified, membership remains paused until manually reactivated

Business Rules & Validations:

Customer Portal Restrictions: When called from customer portal, additional validations apply:
- Cannot modify frozen memberships (freeze till min cycle condition)
- Must respect billing cycle limits configured by merchant
Contract Validation: System validates that the contract belongs to the authenticated shop
Activity Logging: All status changes are logged with source (merchant portal vs customer portal)

Use Cases:

Customer wants to pause their membership temporarily
Merchant needs to cancel a membership due to customer request
Reactivating a paused membership
Marking membership as expired when max cycles reached

Authentication: Requires authenticated shop user or customer portal token

PUT

memberships

api

subscription-contracts-update-status

Update membership contract status

curl --request PUT \
  --url https://www.myshop.com/apps/memberships/cp/api/subscription-contracts-update-status

const options = {method: 'PUT'};

fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-contracts-update-status', 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-contracts-update-status';
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/memberships/cp/api/subscription-contracts-update-status",
  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/memberships/cp/api/subscription-contracts-update-status"

	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/memberships/cp/api/subscription-contracts-update-status")

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

Query Parameters

contractId

integer<int64>

required

Membership contract ID (numeric ID, not Shopify GID)

status

enum<string>

required

New status value

Available options:

ACTIVE,

PAUSED,

CANCELLED,

EXPIRED

pauseDurationCycle

integer<int32>

Optional pause duration in billing cycles. When specified, membership will auto-resume after N cycles

Response

Membership status updated successfully (no content returned)

Update membership contract status

curl --request PUT \
  --url https://www.myshop.com/apps/memberships/cp/api/subscription-contracts-update-status

const options = {method: 'PUT'};

fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-contracts-update-status', 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-contracts-update-status';
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/memberships/cp/api/subscription-contracts-update-status",
  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/memberships/cp/api/subscription-contracts-update-status"

	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/memberships/cp/api/subscription-contracts-update-status")

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

Get Started

Guides

Partner Integration

Webhooks

Admin API

Customer Portal API

Update membership contract status

Query Parameters

Response