Subscription Data
Get delivery options for subscription contract
Retrieves all valid delivery methods available for a specific subscription contract. Returns shipping profiles and delivery options based on the contract’s delivery address and product characteristics.
Market-driven shipping: Each response entry has profileName, methodDefinitions and, on opted-in shops, liveRates. For market-driven shops methodDefinitions is empty and liveRates contains current eligible quotes with name, code, amount, currencyCode and deliveryType (SHIPPING, LOCAL or PICK_UP). An empty liveRates list means no eligible quotes. Live quote codes are not Market option IDs and must not be passed as delivery-method-id. For external method updates, supply a configured option ID from Shopify (the same ID used by the merchant portal’s shipping catalogue); the server re-quotes it for the contract.
Delivery Information Returned:
- Available shipping profiles
- Delivery methods for each profile
- Shipping rates and costs
- Delivery speed (standard, express, etc.)
- Method names and descriptions
- Eligibility based on address and products
Filtering Behavior: By default, returns only delivery methods valid for the contract:
- Matches delivery address country/region
- Compatible with subscription products
- Available for contract weight/dimensions
Include All Methods:
Use header X-Include-All-Methods: true to return all delivery methods regardless of eligibility. Useful for admin UIs where you want to show all legacy profile methods. Market-driven shops always return eligible live quotes; this header does not widen them.
Use Cases:
- Display delivery method selector in customer portal
- Allow customers to change shipping method
- Calculate shipping costs for subscription
- Validate delivery method during subscription updates
- Show upgrade options (standard to express)
Common Scenarios:
Customer Portal - Change Delivery Speed:
- Call this endpoint with contractId
- Display available methods to customer
- Customer selects preferred method
- Update subscription with new delivery method ID
Subscription Creation - Delivery Selection:
- Get delivery options for draft contract
- Present options during checkout/signup
- Create subscription with selected method
Important Notes:
- Delivery options depend on current contract address
- Changing address may change available methods
- Costs may vary based on products in subscription
- Some methods may have minimum order requirements
- International shipping may have additional restrictions
Authentication: Requires X-API-Key header
GET
/
api
/
external
/
v2
/
data
/
contract-delivery-options
Get delivery options for subscription contract
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-optionsimport requests
url = "https://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options', 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/data/contract-delivery-options';
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://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options",
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://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options"
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://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options")
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[
{
"methodDefinitions": [
{
"eligible": true,
"id": "gid://shopify/DeliveryMethodDefinition/123",
"name": "Standard",
"rateProvider": {
"__typename": "DeliveryRateDefinition",
"price": {
"amount": "5.99",
"currencyCode": "USD"
}
}
}
],
"profileName": "Standard Shipping"
}
]⌘I
Get delivery options for subscription contract
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-optionsimport requests
url = "https://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options', 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/data/contract-delivery-options';
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://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options",
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://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options"
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://subscription-admin.appstle.com/api/external/v2/data/contract-delivery-options")
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[
{
"methodDefinitions": [
{
"eligible": true,
"id": "gid://shopify/DeliveryMethodDefinition/123",
"name": "Standard",
"rateProvider": {
"__typename": "DeliveryRateDefinition",
"price": {
"amount": "5.99",
"currencyCode": "USD"
}
}
}
],
"profileName": "Standard Shipping"
}
]