Billing & Orders

Skip upcoming subscription order

Skips a scheduled billing attempt, preventing the order from being processed. The next billing date is automatically recalculated based on the subscription frequency.

Key Features:

Flexible Skipping: Skip any upcoming order
Auto-Rescheduling: Next billing date automatically adjusted
Prepaid Support: Handles both regular and prepaid subscriptions
Activity Logging: Tracks skip events for reporting
Customer Control: Allow members to manage delivery timing

How It Works:

Marks the billing attempt as skipped
Calculates new next billing date (current date + frequency)
Updates subscription contract in Shopify
Logs skip activity with event source
Returns updated billing attempt details

Use Cases:

Customer going on vacation
Too much inventory on hand
Temporary pause without canceling
Budget constraints for specific month
Customize delivery schedule

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

PUT

api

external

subscription-billing-attempts

skip-order

{id}

Skip upcoming subscription order

curl --request PUT \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}

import requests

url = "https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}"

response = requests.put(url)

print(response.text)

const options = {method: 'PUT'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}', 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-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://membership-admin.appstle.com/api/external/v2/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://membership-admin.appstle.com/api/external/v2/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://membership-admin.appstle.com/api/external/v2/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

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

Headers

X-API-Key

string

Path Parameters

integer<int64>

required

Billing attempt ID to skip

Query Parameters

api_key

string

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

subscriptionContractId

integer<int64>

Subscription contract ID

isPrepaid

boolean

default:false

Whether this is a prepaid subscription

Response

Order successfully skipped, returns updated billing attempt

retryingNeeded

boolean

required

shop

string

required

Shop domain identifier

Example:

"my-store.myshopify.com"

applyUsageCharge

boolean

attemptCount

integer<int32>

Number of billing retry attempts

Example:

1

attemptTime

string<date-time>

billingAttemptId

string

Shopify billing attempt ID

billingAttemptResponseMessage

string

billingDate

string<date-time>

Scheduled billing date for this attempt

contractId

integer<int64>

Associated subscription contract ID

Example:

67890

graphOrderId

string

integer<int64>

Unique identifier of the billing attempt record

Example:

12345

orderAmount

number<double>

Total order amount

Example:

29.99

orderAmountUSD

number<double>

orderId

integer<int64>

Shopify order ID if billing was successful

orderName

string

Shopify order name/number

Example:

"#1001"

orderNote

string

Order note or special instructions

progressAttemptCount

integer<int32>

recurringChargeId

integer<int64>

securityChallengeSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

EMAIL_SETTINGS_DISABLED,

CONTRACT_CANCELLED

status

enum<string>

Current status of the billing attempt

Available options:

SUCCESS,

FAILURE,

REQUESTING,

PROGRESS,

QUEUED,

SKIPPED,

SOCIAL_CONNECTION_NULL,

CONTRACT_CANCELLED,

CONTRACT_ENDED,

CONTRACT_PAUSED,

AUTO_CHARGE_DISABLED,

SKIPPED_DUNNING_MGMT,

SECURITY_CHALLENGE,

SHOPIFY_EXCEPTION

transactionFailedEmailSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

EMAIL_SETTINGS_DISABLED,

CUSTOMER_PAYMENT_EMPTY,

CONTRACT_CANCELLED

transactionFailedSmsSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

SMS_SETTINGS_DISABLED,

CUSTOMER_PAYMENT_EMPTY,

CONTRACT_CANCELLED,

PHONE_NUMBER_EMPTY

transactionRate

number<double>

upcomingOrderEmailSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

EMAIL_SETTINGS_DISABLED,

CUSTOMER_PAYMENT_EMPTY,

CONTRACT_CANCELLED,

STOP_FROM_CONTRACT,

CONTRACT_PAUSED

upcomingOrderSmsSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

SMS_SETTINGS_DISABLED,

CUSTOMER_PAYMENT_EMPTY,

CONTRACT_CANCELLED,

STOP_FROM_CONTRACT,

CONTRACT_PAUSED,

PHONE_NUMBER_EMPTY

upgradeDowngradeBilling

boolean

usageChargeStatus

enum<string>

Available options:

SUCCESS,

FAILED,

TO_BE_TRIED

variantList

object[]

Show child attributes

Get paginated past or upcoming orders report

Get upcoming orders

Skip upcoming subscription order

curl --request PUT \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}

import requests

url = "https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}"

response = requests.put(url)

print(response.text)

const options = {method: 'PUT'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}', 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-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://membership-admin.appstle.com/api/external/v2/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://membership-admin.appstle.com/api/external/v2/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://membership-admin.appstle.com/api/external/v2/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

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}