One-Time Add-Ons

Get one-time add-ons for a membership contract

Retrieves all one-time product additions scheduled for upcoming orders of a specific membership contract. One-offs are products added to a single billing cycle without affecting the recurring subscription items.

Key Information Returned:

One-Off Items: List of products added to upcoming orders
Product Details: Variant ID, handle, title, price, image
Billing Association: Which billing attempt the item is added to
Quantity: Number of units for the one-time add-on
Status: Active, pending, or fulfilled one-offs
Created Date: When the one-off was added

One-Off Item Data:

Contract ID: Parent subscription contract
Billing Attempt ID: Specific order the item will be added to
Variant Info: Product variant being added
Pricing: One-time price for the add-on
Fulfillment Status: Whether item has been shipped

Use Cases:

Display scheduled one-time add-ons in customer portal
Show customers which extra items are in next order
Sync one-off data with external order management systems
Generate custom order previews for customers
Build upsell dashboards showing add-on purchases
Track one-time product revenue per contract

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

GET

api

external

subscription-contract-one-offs-by-contractId

Get one-time add-ons for a membership contract

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId

const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId';
const options = {method: 'GET'};

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://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

	req, _ := http.NewRequest("GET", 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://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId")

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

request = Net::HTTP::Get.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
  }
]

[
  {
    "shop": "my-store.myshopify.com",
    "billingAttemptId": 123,
    "id": 789,
    "subscriptionContractId": 123,
    "variantHandle": "<string>",
    "variantId": 123
  }
]

[
  {
    "shop": "my-store.myshopify.com",
    "billingAttemptId": 123,
    "id": 789,
    "subscriptionContractId": 123,
    "variantHandle": "<string>",
    "variantId": 123
  }
]

[
  {
    "shop": "my-store.myshopify.com",
    "billingAttemptId": 123,
    "id": 789,
    "subscriptionContractId": 123,
    "variantHandle": "<string>",
    "variantId": 123
  }
]

Headers

X-API-Key

string

Query Parameters

api_key

string

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

contractId

integer<int64>

required

Subscription contract ID

Response

One-off items successfully retrieved

shop

string

required

Shop domain identifier

Example:

"my-store.myshopify.com"

billingAttemptId

integer<int64>

Associated billing attempt ID

integer<int64>

Unique identifier of the one-off item

Example:

789

subscriptionContractId

integer<int64>

Associated subscription contract ID

variantHandle

string

Product variant handle for the one-off item

variantId

integer<int64>

Shopify product variant ID of the one-off item

Get one-time add-ons for a membership contract

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId

const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId';
const options = {method: 'GET'};

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://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

	req, _ := http.NewRequest("GET", 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://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId")

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

request = Net::HTTP::Get.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
  }
]

[
  {
    "shop": "my-store.myshopify.com",
    "billingAttemptId": 123,
    "id": 789,
    "subscriptionContractId": 123,
    "variantHandle": "<string>",
    "variantId": 123
  }
]

[
  {
    "shop": "my-store.myshopify.com",
    "billingAttemptId": 123,
    "id": 789,
    "subscriptionContractId": 123,
    "variantHandle": "<string>",
    "variantId": 123
  }
]

[
  {
    "shop": "my-store.myshopify.com",
    "billingAttemptId": 123,
    "id": 789,
    "subscriptionContractId": 123,
    "variantHandle": "<string>",
    "variantId": 123
  }
]

Get Started

Guides

Partner Integration

Webhooks

Admin API

Customer Portal API

Get one-time add-ons for a membership contract

Headers

Query Parameters

Response