One-Time Add-Ons
Add or update one-off item
Adds or updates a one-time product for a specific subscription contract’s upcoming billing attempt.
PUT
/
memberships
/
cp
/
api
/
subscription-contract-one-offs-by-contractId-and-billing-attempt-id
Add or update one-off item
curl --request PUT \
--url https://www.myshop.com/apps/memberships/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-idimport requests
url = "https://www.myshop.com/apps/memberships/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id"
response = requests.put(url)
print(response.text)const options = {method: 'PUT'};
fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id', 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-one-offs-by-contractId-and-billing-attempt-id';
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-contract-one-offs-by-contractId-and-billing-attempt-id",
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-contract-one-offs-by-contractId-and-billing-attempt-id"
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-contract-one-offs-by-contractId-and-billing-attempt-id")
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": "my-store.myshopify.com",
"billingAttemptId": 123,
"id": 789,
"subscriptionContractId": 123,
"variantHandle": "<string>",
"variantId": 123
}
]Query Parameters
Response
200 - */*
OK
Shop domain identifier
Example:
"my-store.myshopify.com"
Associated billing attempt ID
Unique identifier of the one-off item
Example:
789
Associated subscription contract ID
Product variant handle for the one-off item
Shopify product variant ID of the one-off item
⌘I
Add or update one-off item
curl --request PUT \
--url https://www.myshop.com/apps/memberships/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-idimport requests
url = "https://www.myshop.com/apps/memberships/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id"
response = requests.put(url)
print(response.text)const options = {method: 'PUT'};
fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id', 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-one-offs-by-contractId-and-billing-attempt-id';
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-contract-one-offs-by-contractId-and-billing-attempt-id",
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-contract-one-offs-by-contractId-and-billing-attempt-id"
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-contract-one-offs-by-contractId-and-billing-attempt-id")
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": "my-store.myshopify.com",
"billingAttemptId": 123,
"id": 789,
"subscriptionContractId": 123,
"variantHandle": "<string>",
"variantId": 123
}
]