# Skip the next upcoming order for a subscription

Skips the next scheduled billing attempt for a subscription contract without requiring the billing attempt ID. Automatically finds and skips the earliest QUEUED billing attempt.

Convenience Feature:
- No need to know the specific billing attempt ID
- Automatically finds the next order
- Ideal for "skip next order" functionality in customer portals

Use Cases:
- Simple "skip next delivery" button in customer portal
- Quick skip without looking up billing attempt details
- One-click skip functionality

Authentication: Requires valid X-API-Key header

Endpoint: PUT /api/external/v2/subscription-billing-attempts/skip-upcoming-order
Version: 0.0.1

## Query parameters:

  - `api_key` (string)
    API Key (Deprecated - Use Header X-API-Key instead)

  - `subscriptionContractId` (integer)
    Subscription Contract ID

## Header parameters:

  - `X-API-Key` (string)

## Response 200 fields (application/json):

  - `id` (integer)

  - `shop` (string, required)

  - `billingAttemptId` (string)

  - `status` (string)
    Enum: "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"

  - `billingDate` (string)

  - `contractId` (integer)

  - `attemptCount` (integer)

  - `attemptTime` (string)

  - `graphOrderId` (string)

  - `orderId` (integer)

  - `orderAmount` (number)

  - `orderName` (string)

  - `retryingNeeded` (boolean, required)

  - `transactionFailedEmailSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED"

  - `upcomingOrderEmailSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "STOP_FROM_CONTRACT", "CONTRACT_PAUSED"

  - `applyUsageCharge` (boolean)

  - `recurringChargeId` (integer)

  - `transactionRate` (number)

  - `usageChargeStatus` (string)
    Enum: "SUCCESS", "FAILED", "TO_BE_TRIED"

  - `transactionFailedSmsSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "SMS_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "PHONE_NUMBER_EMPTY"

  - `upcomingOrderSmsSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "SMS_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "STOP_FROM_CONTRACT", "CONTRACT_PAUSED", "PHONE_NUMBER_EMPTY"

  - `billingAttemptResponseMessage` (string)

  - `progressAttemptCount` (integer)

  - `orderNote` (string)

  - `variantList` (array)

  - `variantList.variantId` (integer)

  - `variantList.quantity` (integer)

  - `variantList.title` (string)

  - `variantList.image` (string)

  - `variantList.productTitle` (string)

  - `variantList.productId` (string)

  - `variantList.variantTitle` (string)

  - `variantList.swapId` (integer)

  - `securityChallengeSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CONTRACT_CANCELLED"

  - `orderAmountUSD` (number)

  - `orderCancelReason` (string)
    Enum: "CUSTOMER", "DECLINED", "FRAUD", "INVENTORY", "STAFF", "OTHER", "$UNKNOWN"

  - `orderCancelledAt` (string)

  - `orderClosed` (boolean)

  - `orderClosedAt` (string)

  - `orderConfirmed` (boolean)

  - `orderDisplayFinancialStatus` (string)
    Enum: "PENDING", "AUTHORIZED", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "VOIDED", "PAID", "REFUNDED", "EXPIRED", "$UNKNOWN"

  - `orderDisplayFulfillmentStatus` (string)
    Enum: "UNFULFILLED", "PARTIALLY_FULFILLED", "FULFILLED", "RESTOCKED", "PENDING_FULFILLMENT", "OPEN", "IN_PROGRESS", "ON_HOLD", "SCHEDULED", "REQUEST_DECLINED", "$UNKNOWN"

  - `orderProcessedAt` (string)

  - `lastShippingUpdatedAt` (string)

  - `inventorySkippedAttemptCount` (integer)

  - `inventorySkippedRetryingNeeded` (boolean)

  - `orderAttributes` (array)

  - `orderAttributes.key` (string)

  - `orderAttributes.value` (string)

  - `partialLinesSkipped` (string)
    Enum: "INVENTORY_MANAGEMENT", "MANUAL"

  - `orderAmountContractCurrency` (number)

## Response 401 fields (*/*):

  - `id` (integer)

  - `shop` (string, required)

  - `billingAttemptId` (string)

  - `status` (string)
    Enum: "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"

  - `billingDate` (string)

  - `contractId` (integer)

  - `attemptCount` (integer)

  - `attemptTime` (string)

  - `graphOrderId` (string)

  - `orderId` (integer)

  - `orderAmount` (number)

  - `orderName` (string)

  - `retryingNeeded` (boolean, required)

  - `transactionFailedEmailSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED"

  - `upcomingOrderEmailSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "STOP_FROM_CONTRACT", "CONTRACT_PAUSED"

  - `applyUsageCharge` (boolean)

  - `recurringChargeId` (integer)

  - `transactionRate` (number)

  - `usageChargeStatus` (string)
    Enum: "SUCCESS", "FAILED", "TO_BE_TRIED"

  - `transactionFailedSmsSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "SMS_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "PHONE_NUMBER_EMPTY"

  - `upcomingOrderSmsSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "SMS_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "STOP_FROM_CONTRACT", "CONTRACT_PAUSED", "PHONE_NUMBER_EMPTY"

  - `billingAttemptResponseMessage` (string)

  - `progressAttemptCount` (integer)

  - `orderNote` (string)

  - `variantList` (array)

  - `variantList.variantId` (integer)

  - `variantList.quantity` (integer)

  - `variantList.title` (string)

  - `variantList.image` (string)

  - `variantList.productTitle` (string)

  - `variantList.productId` (string)

  - `variantList.variantTitle` (string)

  - `variantList.swapId` (integer)

  - `securityChallengeSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CONTRACT_CANCELLED"

  - `orderAmountUSD` (number)

  - `orderCancelReason` (string)
    Enum: "CUSTOMER", "DECLINED", "FRAUD", "INVENTORY", "STAFF", "OTHER", "$UNKNOWN"

  - `orderCancelledAt` (string)

  - `orderClosed` (boolean)

  - `orderClosedAt` (string)

  - `orderConfirmed` (boolean)

  - `orderDisplayFinancialStatus` (string)
    Enum: "PENDING", "AUTHORIZED", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "VOIDED", "PAID", "REFUNDED", "EXPIRED", "$UNKNOWN"

  - `orderDisplayFulfillmentStatus` (string)
    Enum: "UNFULFILLED", "PARTIALLY_FULFILLED", "FULFILLED", "RESTOCKED", "PENDING_FULFILLMENT", "OPEN", "IN_PROGRESS", "ON_HOLD", "SCHEDULED", "REQUEST_DECLINED", "$UNKNOWN"

  - `orderProcessedAt` (string)

  - `lastShippingUpdatedAt` (string)

  - `inventorySkippedAttemptCount` (integer)

  - `inventorySkippedRetryingNeeded` (boolean)

  - `orderAttributes` (array)

  - `orderAttributes.key` (string)

  - `orderAttributes.value` (string)

  - `partialLinesSkipped` (string)
    Enum: "INVENTORY_MANAGEMENT", "MANUAL"

  - `orderAmountContractCurrency` (number)

## Response 403 fields (*/*):

  - `id` (integer)

  - `shop` (string, required)

  - `billingAttemptId` (string)

  - `status` (string)
    Enum: "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"

  - `billingDate` (string)

  - `contractId` (integer)

  - `attemptCount` (integer)

  - `attemptTime` (string)

  - `graphOrderId` (string)

  - `orderId` (integer)

  - `orderAmount` (number)

  - `orderName` (string)

  - `retryingNeeded` (boolean, required)

  - `transactionFailedEmailSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED"

  - `upcomingOrderEmailSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "STOP_FROM_CONTRACT", "CONTRACT_PAUSED"

  - `applyUsageCharge` (boolean)

  - `recurringChargeId` (integer)

  - `transactionRate` (number)

  - `usageChargeStatus` (string)
    Enum: "SUCCESS", "FAILED", "TO_BE_TRIED"

  - `transactionFailedSmsSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "SMS_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "PHONE_NUMBER_EMPTY"

  - `upcomingOrderSmsSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "SMS_SETTINGS_DISABLED", "CUSTOMER_PAYMENT_EMPTY", "CONTRACT_CANCELLED", "STOP_FROM_CONTRACT", "CONTRACT_PAUSED", "PHONE_NUMBER_EMPTY"

  - `billingAttemptResponseMessage` (string)

  - `progressAttemptCount` (integer)

  - `orderNote` (string)

  - `variantList` (array)

  - `variantList.variantId` (integer)

  - `variantList.quantity` (integer)

  - `variantList.title` (string)

  - `variantList.image` (string)

  - `variantList.productTitle` (string)

  - `variantList.productId` (string)

  - `variantList.variantTitle` (string)

  - `variantList.swapId` (integer)

  - `securityChallengeSentStatus` (string)
    Enum: "SENT", "UNSENT", "FAILED", "EMAIL_SETTINGS_DISABLED", "CONTRACT_CANCELLED"

  - `orderAmountUSD` (number)

  - `orderCancelReason` (string)
    Enum: "CUSTOMER", "DECLINED", "FRAUD", "INVENTORY", "STAFF", "OTHER", "$UNKNOWN"

  - `orderCancelledAt` (string)

  - `orderClosed` (boolean)

  - `orderClosedAt` (string)

  - `orderConfirmed` (boolean)

  - `orderDisplayFinancialStatus` (string)
    Enum: "PENDING", "AUTHORIZED", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "VOIDED", "PAID", "REFUNDED", "EXPIRED", "$UNKNOWN"

  - `orderDisplayFulfillmentStatus` (string)
    Enum: "UNFULFILLED", "PARTIALLY_FULFILLED", "FULFILLED", "RESTOCKED", "PENDING_FULFILLMENT", "OPEN", "IN_PROGRESS", "ON_HOLD", "SCHEDULED", "REQUEST_DECLINED", "$UNKNOWN"

  - `orderProcessedAt` (string)

  - `lastShippingUpdatedAt` (string)

  - `inventorySkippedAttemptCount` (integer)

  - `inventorySkippedRetryingNeeded` (boolean)

  - `orderAttributes` (array)

  - `orderAttributes.key` (string)

  - `orderAttributes.value` (string)

  - `partialLinesSkipped` (string)
    Enum: "INVENTORY_MANAGEMENT", "MANUAL"

  - `orderAmountContractCurrency` (number)


## Response 400 fields