Skip to main content
PUT
Skip a specific order

Headers

X-API-Key
string

Path Parameters

id
integer<int64>
required

Billing Attempt ID

Query Parameters

api_key
string

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

subscriptionContractId
integer<int64>

Subscription Contract ID

isPrepaid
boolean
default:false

Is this contract Prepaid?

Response

Order successfully skipped

retryingNeeded
boolean
required
shop
string
required
applyUsageCharge
boolean
attemptCount
integer<int32>

How many charges have been sent to Shopify for this renewal. A retry after a failed payment adds one. A stock check that holds the renewal does not.

attemptTime
string<date-time>

When Appstle last tried this renewal: the latest charge, or the latest stock check that held it. Each try overwrites it, so it is not a history.

billingAttemptId
string

Shopify's ID for the most recent charge Shopify created for this renewal. Each new one replaces it. It is null until Shopify has created one, for example on a renewal that has so far only been held for out-of-stock items. A renewal combined into another one carries the combined charge's ID, so two renewals can share it: key on id, not on this field.

billingAttemptResponseMessage
string

Why the last charge for this renewal failed. When Shopify declined the payment, it is Shopify's failure notification as a JSON string: parse it and read error_code and error_message. When Shopify rejected the charge or returned an error, it is Shopify's error text. It is null until a charge fails, and a renewal that later succeeds keeps the last failure's value.

billingDate
string<date-time>
contractId
integer<int64>
graphOrderId
string
id
integer<int64>

Appstle's ID for one scheduled renewal of one contract. It stays the same through every retry of that renewal, so use it as the key. It is not a Shopify ID.

inventorySkippedAttemptCount
integer<int32>

How many times this renewal was held entirely because an item was out of stock. It is null until the first hold, and Appstle never resets it. An order that goes out without its out-of-stock items (see partialLinesSkipped) does not add to it.

inventorySkippedRetryingNeeded
boolean

Whether Appstle will check stock again for this renewal, following the store's out-of-stock retry settings. It only matters while status is SKIPPED_INVENTORY_MGMT and the subscription is active. It is not cleared when the renewal is later billed or the subscription is cancelled, so read status first.

lastShippingUpdatedAt
string<date-time>
orderAmount
number<double>

The renewal order's total as Shopify reports it, in the store's currency. It is null until the order exists. On the checkout row that past orders adds when you filter by contractId, it is the contract's orderAmount: only this subscription's lines and their tax.

orderAmountContractCurrency
number<double>
orderAmountShopCurrency
number<double>
orderAmountUSD
number<double>
orderAttributes
object[]
orderCancelReason
enum<string>
Available options:
CUSTOMER,
DECLINED,
FRAUD,
INVENTORY,
STAFF,
OTHER,
$UNKNOWN
orderCancelledAt
string<date-time>
orderClosed
boolean
orderClosedAt
string<date-time>
orderConfirmed
boolean
orderDisplayFinancialStatus
enum<string>
Available options:
PENDING,
AUTHORIZED,
PARTIALLY_PAID,
PARTIALLY_REFUNDED,
VOIDED,
PAID,
REFUNDED,
EXPIRED,
$UNKNOWN
orderDisplayFulfillmentStatus
enum<string>
Available options:
UNFULFILLED,
PARTIALLY_FULFILLED,
FULFILLED,
RESTOCKED,
PENDING_FULFILLMENT,
OPEN,
IN_PROGRESS,
ON_HOLD,
SCHEDULED,
REQUEST_DECLINED,
$UNKNOWN
orderId
integer<int64>
orderName
string
orderNote
string
orderProcessedAt
string<date-time>
partialLinesSkipped
enum<string>

Why some lines were left out of this order: INVENTORY_MANAGEMENT (out-of-stock items), MANUAL (products set to be skipped for this order) or ORPHANED_FREE_PRODUCT (a free product left out because no paid product from its plan is in the order). It holds one reason even when several apply. null when no lines were left out.

Available options:
INVENTORY_MANAGEMENT,
MANUAL,
ORPHANED_FREE_PRODUCT
progressAttemptCount
integer<int32>
recurringChargeId
integer<int64>
securityChallengeSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
EMAIL_SETTINGS_DISABLED,
CONTRACT_CANCELLED
status
enum<string>

Where this renewal stands. QUEUED: scheduled and not yet charged. SUCCESS: the charge succeeded and Shopify created the order. FAILURE: Shopify declined the payment or rejected the charge. SHOPIFY_EXCEPTION: Shopify returned an error when Appstle asked it to charge. SKIPPED_DUNNING_MGMT: the charge kept failing, and the store's failed-payment settings skipped the renewal. SKIPPED: the renewal was skipped. SKIPPED_INVENTORY_MGMT: held for an out-of-stock item. CONTRACT_PAUSED or CONTRACT_CANCELLED: the renewal came due while the contract was paused or cancelled, so it wasn't charged.

Available options:
SUCCESS,
FAILURE,
REQUESTING,
PROGRESS,
QUEUED,
SKIPPED,
SOCIAL_CONNECTION_NULL,
CONTRACT_CANCELLED,
CONTRACT_ENDED,
CONTRACT_PAUSED,
AUTO_CHARGE_DISABLED,
SHOPIFY_EXCEPTION,
SKIPPED_DUNNING_MGMT,
SKIPPED_INVENTORY_MGMT,
IMMEDIATE_TRIGGERED,
SECURITY_CHALLENGE,
CONTRACT_PAUSED_MAX_CYCLES,
REFUNDED,
SKIPPED_DEMO_SHOP,
SKIPPED_SHOP_INFO_NOT_FOUND,
SKIPPED_BILLING_DATE_STALE,
SKIPPED_DUNNING_NOT_CONFIGURED,
PENDING_CONSOLIDATION
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
usageChargeStatus
enum<string>
Available options:
SUCCESS,
FAILED,
TO_BE_TRIED
variantList
object[]