Subscription One-Time Products

Remove one-time product from subscription order

Removes a previously added one-time product from a specific subscription order. This permanently deletes the one-time product from the specified billing attempt. The operation is idempotent - attempting to delete a non-existent product will succeed without error.

Important Notes:

Only removes the product from the specified billing attempt
Cannot remove products from billing attempts that are already processed
Activity logs are created for audit trails
Returns the updated list of all one-time products for the contract

Use Cases:

Allow customers to remove unwanted add-ons before order processing
Clean up cart-like functionality in customer portals
Programmatically manage one-time product selections
Implement “undo” functionality for product additions

Business Rules:

Contract must belong to the authenticated shop
The specific combination of contractId + billingAttemptId + variantId identifies the product to remove
No error is thrown if the product doesn’t exist (idempotent operation)

Authentication: Requires valid X-API-Key header that identifies the shop

DELETE

api

external

subscription-contract-one-offs-by-contractId-and-billing-attempt-id

Remove one-time product from subscription order

curl --request DELETE \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id \
  --header 'X-API-Key: <x-api-key>'

import requests

url = "https://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://subscription-admin.appstle.com/api/external/v2/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://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id';
const options = {method: 'DELETE', headers: {'X-API-Key': '<x-api-key>'}};

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://subscription-admin.appstle.com/api/external/v2/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 => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$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://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id"

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

	req.Header.Add("X-API-Key", "<x-api-key>")

	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://subscription-admin.appstle.com/api/external/v2/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::Delete.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

[]

Headers

X-API-Key

string

required

API Key for authentication. This key identifies your shop and must be included in the X-API-Key header.

Query Parameters

api_key

string

API Key (Deprecated - Use X-API-Key header instead)

contractId

integer<int64>

required

The unique identifier of the subscription contract

Required range: x >= 1

billingAttemptId

integer<int64>

required

The billing attempt ID that contains the product to remove

Required range: x >= 1

variantId

integer<int64>

required

The Shopify product variant ID to remove from the one-time purchases

Required range: x >= 1

Response

Successfully removed the one-time product or product didn't exist. Returns all remaining one-time products for the contract.

shop

string

required

The Shopify store domain that owns this subscription

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*\.myshopify\.com$

Example:

"example-store.myshopify.com"

billingAttemptId

integer<int64>

The billing attempt ID this one-time product is associated with. This determines which upcoming order will include this product.

Required range: x >= 1

Example:

54321

integer<int64>

read-only

Unique identifier of the one-time product record

Example:

12345

price

number<double>

The price per unit of this product in the shop's base currency. This may include any applicable discounts.

Required range: 0 <= x <= 999999.99

Example:

19.99

quantity

integer<int32>

The quantity of this product to include in the order

Required range: 1 <= x <= 999

Example:

2

subscriptionContractId

integer<int64>

The subscription contract ID this one-time product belongs to

Required range: x >= 1

Example:

98765

variantHandle

string

The handle/slug of the product variant for URL-friendly identification

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Example:

"premium-coffee-blend-500g"

variantId

integer<int64>

The Shopify product variant ID for this one-time product

Required range: x >= 1

Example:

42549172011164

Remove one-time product from subscription order

curl --request DELETE \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id \
  --header 'X-API-Key: <x-api-key>'

import requests

url = "https://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://subscription-admin.appstle.com/api/external/v2/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://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id';
const options = {method: 'DELETE', headers: {'X-API-Key': '<x-api-key>'}};

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://subscription-admin.appstle.com/api/external/v2/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 => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$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://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id"

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

	req.Header.Add("X-API-Key", "<x-api-key>")

	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://subscription-admin.appstle.com/api/external/v2/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::Delete.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

[]

Get Started

Guides

Partner Integration

Webhooks

Admin API

Storefront API

Resources

Remove one-time product from subscription order

Headers

Query Parameters

Response