Subscription Contracts
Update next billing date for a subscription contract
Reschedules the next billing date for an active subscription contract. This endpoint allows you to change when the next order will be created and processed.
Key Features:
- Updates the next billing date to the specified date
- Optionally reschedules all future orders based on the new date
- Syncs the updated date to Shopify
- Sends confirmation email to customer
The rescheduleFutureOrder Parameter:
- true (default): Updates the next billing date AND recalculates all future queued orders based on the new date. Use this to shift the entire billing schedule.
- false: Only updates the next billing date. Other queued orders remain unchanged. Use this for one-time date adjustments.
Important Notes:
- The new date must be in the future (with 10 minute grace period)
- Date is validated against the shop’s timezone
- If anchor days are configured, future orders may align to those anchors
- The store’s Appstle plan must include next billing date changes. API access alone isn’t enough, and scoped partner tokens need it too. Stores that choose a paid plan today get it, and the Free plan doesn’t include it. A store that chose its plan earlier, or is on a custom plan, may not have it: support@appstle.com can check. Without it, the call returns
400witherrorKeypermissionDeniedand the messageUserGeneratedError:Upgrade your plan to modify next billing date.
Process Flow:
- Validates the contract exists and belongs to the shop
- Validates the new date is not in the past
- Updates the billing attempt to the new date
- Syncs the updated nextBillingDate to Shopify
- If rescheduleFutureOrder=true, regenerates the queue from the new date
- Sends confirmation email to customer
- Records activity log entry
Date Format:
- Must be ISO 8601 format with timezone
- Examples:
2024-03-15T12:00:00Z,2024-03-15T12:00:00+05:30 - URL encode the date when passing as query parameter
Timezone Handling:
- The provided date is used as-is for the billing attempt
- Validation (past date check) uses the shop’s configured timezone
- All dates in the response are in UTC (Z suffix)
Date Restrictions (Customer Portal Only): When called from customer portal context:
- Minimum days from today (skipDaysFromCurrentDate setting)
- Maximum days from today (billingDateRestrictToDays setting)
- External API calls bypass these restrictions
Authentication: Requires a signed-in customer. Call it through Shopify’s App Proxy on the store’s domain: the proxy signs the request and attaches the customer, so you send no API key.
PUT
/
subscriptions
/
cp
/
api
/
subscription-contracts-update-billing-date
Update next billing date for a subscription contract
curl --request PUT \
--url https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-billing-dateimport requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-billing-date"
response = requests.put(url)
print(response.text)const options = {method: 'PUT'};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-billing-date', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-billing-date';
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/subscriptions/cp/api/subscription-contracts-update-billing-date",
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/subscriptions/cp/api/subscription-contracts-update-billing-date"
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/subscriptions/cp/api/subscription-contracts-update-billing-date")
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{
"__typename": "SubscriptionContract",
"billingPolicy": {
"interval": "MONTH",
"intervalCount": 1
},
"customer": {
"displayName": "John Doe",
"email": "customer@example.com"
},
"id": "gid://shopify/SubscriptionContract/123456789",
"nextBillingDate": "2024-03-15T12:00:00Z",
"status": "ACTIVE",
"updatedAt": "2024-02-15T10:30:00Z"
}Query Parameters
Response
Billing date successfully updated. The response contains the updated subscription contract from Shopify with the new nextBillingDate.
⌘I
Update next billing date for a subscription contract
curl --request PUT \
--url https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-billing-dateimport requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-billing-date"
response = requests.put(url)
print(response.text)const options = {method: 'PUT'};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-billing-date', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-billing-date';
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/subscriptions/cp/api/subscription-contracts-update-billing-date",
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/subscriptions/cp/api/subscription-contracts-update-billing-date"
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/subscriptions/cp/api/subscription-contracts-update-billing-date")
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{
"__typename": "SubscriptionContract",
"billingPolicy": {
"interval": "MONTH",
"intervalCount": 1
},
"customer": {
"displayName": "John Doe",
"email": "customer@example.com"
},
"id": "gid://shopify/SubscriptionContract/123456789",
"nextBillingDate": "2024-03-15T12:00:00Z",
"status": "ACTIVE",
"updatedAt": "2024-02-15T10:30:00Z"
}