Billing & Orders
Skip an upcoming billing order
Skips the next scheduled billing/order for a membership contract. The membership remains active, but the next billing date is moved to the following cycle.
Key Features:
- Skip next billing without canceling membership
- Automatically reschedule to next billing cycle
- Works for both regular and prepaid memberships
- Activity logging for audit trail
How It Works:
- Validates billing attempt exists and belongs to shop
- Updates next billing date to skip current cycle
- Moves billing to the next scheduled interval
- Logs activity (customer portal vs merchant portal)
Customer Portal Restrictions:
- Cannot skip if membership is frozen until min cycles
- Validates contract ownership for security
Use Cases:
- Customer is traveling and wants to skip one delivery
- Customer has excess inventory and wants to pause one cycle
- Merchant wants to skip a billing due to out-of-stock items
- Skip billing for special circumstances (holidays, etc.)
Prepaid Handling:
- Set
isPrepaid=truefor prepaid memberships - Different validation logic for prepaid vs pay-as-you-go
Authentication: Requires authenticated shop user or customer portal token
PUT
/
memberships
/
cp
/
api
/
subscription-billing-attempts
/
skip-order
/
{id}
Skip an upcoming billing order
curl --request PUT \
--url https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts/skip-order/{id}import requests
url = "https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts/skip-order/{id}"
response = requests.put(url)
print(response.text)const options = {method: 'PUT'};
fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts/skip-order/{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-billing-attempts/skip-order/{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-billing-attempts/skip-order/{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-billing-attempts/skip-order/{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-billing-attempts/skip-order/{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{
"attemptTime": "2023-11-07T05:31:56Z",
"billingAttemptId": "<string>",
"billingDate": "2023-11-07T05:31:56Z",
"contractId": 67890,
"graphOrderId": "<string>",
"id": 12345,
"orderAmount": 29.99,
"orderId": 123,
"orderName": "#1001",
"orderNote": "<string>",
"retryingNeeded": true,
"shop": "my-store.myshopify.com",
"status": "SUCCESS",
"upgradeDowngradeBilling": true,
"variantList": [
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
]
}Query Parameters
Response
Billing order successfully skipped
⌘I
Skip an upcoming billing order
curl --request PUT \
--url https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts/skip-order/{id}import requests
url = "https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts/skip-order/{id}"
response = requests.put(url)
print(response.text)const options = {method: 'PUT'};
fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts/skip-order/{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-billing-attempts/skip-order/{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-billing-attempts/skip-order/{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-billing-attempts/skip-order/{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-billing-attempts/skip-order/{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{
"attemptTime": "2023-11-07T05:31:56Z",
"billingAttemptId": "<string>",
"billingDate": "2023-11-07T05:31:56Z",
"contractId": 67890,
"graphOrderId": "<string>",
"id": 12345,
"orderAmount": 29.99,
"orderId": 123,
"orderName": "#1001",
"orderNote": "<string>",
"retryingNeeded": true,
"shop": "my-store.myshopify.com",
"status": "SUCCESS",
"upgradeDowngradeBilling": true,
"variantList": [
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
]
}