Skip to content
External APIs
/
/
Skip the next upcoming or...

External APIs (0.0.1)

Comprehensive API documentation for managing subscriptions, payments, and related operations. These APIs allow you to programmatically manage subscription lifecycles, handle payments, configure products, and integrate subscription functionality into your applications.

Download OpenAPI description
external-api-swagger.json
external-api-swagger.yaml
Languages
Servers
https://subscription-admin.appstle.com

Subscription Management

Core APIs for managing the complete subscription lifecycle including creation, updates, pausing, resuming, and cancellation of subscriptions.

Operations

Subscription Payments

APIs for managing subscription payment methods, processing payments, handling payment retries, and updating billing information.

Operations

Subscription Contracts

APIs for managing subscription contracts including delivery schedules, pricing, order notes, billing cycles, and shipping addresses.

Operations

Subscription Products

APIs for managing products within subscriptions including adding, removing, updating quantities, and swapping products.

Operations

Billing & Payments

APIs for handling billing operations, payment processing, and financial transactions related to subscriptions.

Operations

Unskip a previously skipped order

Request

Reverses a skip action on a billing attempt. The order will be restored to QUEUED status and will be processed on its scheduled date.

Important Notes:

  • Only works on billing attempts with SKIPPED status
  • Must be done before the scheduled billing date
  • Cannot unskip after the billing date has passed
  • Activity logs are created for audit trail

Use Cases:

  • Customer changes their mind about skipping
  • Correct accidental skip actions
  • Restore delivery after resolving temporary issue

Authentication: Requires valid X-API-Key header

Path
idinteger(int64)required

Billing Attempt ID

Query
api_keystring

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

subscriptionContractIdinteger(int64)

Subscription Contract ID

Headers
X-API-Keystring
curl -i -X PUT \
  'https://subscription-admin.appstle.com/api/external/v2/subscription-billing-attempts/unskip-order/{id}?api_key=string&subscriptionContractId=0' \
  -H 'X-API-Key: string'

Responses

Order successfully unskipped

Bodyapplication/json
idinteger(int64)
shopstringrequired
billingAttemptIdstring
statusstring
Enum"SUCCESS""FAILURE""REQUESTING""PROGRESS""QUEUED""SKIPPED""SOCIAL_CONNECTION_NULL""CONTRACT_CANCELLED""CONTRACT_ENDED""CONTRACT_PAUSED"
billingDatestring(date-time)
contractIdinteger(int64)
attemptCountinteger(int32)
attemptTimestring(date-time)
graphOrderIdstring
orderIdinteger(int64)
orderAmountnumber(double)
orderNamestring
retryingNeededbooleanrequired
transactionFailedEmailSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED"
upcomingOrderEmailSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""STOP_FROM_CONTRACT""CONTRACT_PAUSED"
applyUsageChargeboolean
recurringChargeIdinteger(int64)
transactionRatenumber(double)
usageChargeStatusstring
Enum"SUCCESS""FAILED""TO_BE_TRIED"
transactionFailedSmsSentStatusstring
Enum"SENT""UNSENT""FAILED""SMS_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""PHONE_NUMBER_EMPTY"
upcomingOrderSmsSentStatusstring
Enum"SENT""UNSENT""FAILED""SMS_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""STOP_FROM_CONTRACT""CONTRACT_PAUSED""PHONE_NUMBER_EMPTY"
billingAttemptResponseMessagestring
progressAttemptCountinteger(int32)
orderNotestring
variantListArray of objects(VariantQuantity)
securityChallengeSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CONTRACT_CANCELLED"
orderAmountUSDnumber(double)
orderCancelReasonstring
Enum"CUSTOMER""DECLINED""FRAUD""INVENTORY""STAFF""OTHER""$UNKNOWN"
orderCancelledAtstring(date-time)
orderClosedboolean
orderClosedAtstring(date-time)
orderConfirmedboolean
orderDisplayFinancialStatusstring
Enum"PENDING""AUTHORIZED""PARTIALLY_PAID""PARTIALLY_REFUNDED""VOIDED""PAID""REFUNDED""EXPIRED""$UNKNOWN"
orderDisplayFulfillmentStatusstring
Enum"UNFULFILLED""PARTIALLY_FULFILLED""FULFILLED""RESTOCKED""PENDING_FULFILLMENT""OPEN""IN_PROGRESS""ON_HOLD""SCHEDULED""REQUEST_DECLINED"
orderProcessedAtstring(date-time)
lastShippingUpdatedAtstring(date-time)
inventorySkippedAttemptCountinteger(int32)
inventorySkippedRetryingNeededboolean
orderAttributesArray of objects(AttributeInfo)
partialLinesSkippedstring
Enum"INVENTORY_MANAGEMENT""MANUAL"
orderAmountContractCurrencynumber(double)
Response
application/json
{
  "id": 0,
  "shop": "string",
  "billingAttemptId": "string",
  "status": "SUCCESS",
  "billingDate": "2019-08-24T14:15:22Z",
  "contractId": 0,
  "attemptCount": 0,
  "attemptTime": "2019-08-24T14:15:22Z",
  "graphOrderId": "string",
  "orderId": 0,
  "orderAmount": 0.1,
  "orderName": "string",
  "retryingNeeded": true,
  "transactionFailedEmailSentStatus": "SENT",
  "upcomingOrderEmailSentStatus": "SENT",
  "applyUsageCharge": true,
  "recurringChargeId": 0,
  "transactionRate": 0.1,
  "usageChargeStatus": "SUCCESS",
  "transactionFailedSmsSentStatus": "SENT",
  "upcomingOrderSmsSentStatus": "SENT",
  "billingAttemptResponseMessage": "string",
  "progressAttemptCount": 0,
  "orderNote": "string",
  "variantList": [
    { … }
  ],
  "securityChallengeSentStatus": "SENT",
  "orderAmountUSD": 0.1,
  "orderCancelReason": "CUSTOMER",
  "orderCancelledAt": "2019-08-24T14:15:22Z",
  "orderClosed": true,
  "orderClosedAt": "2019-08-24T14:15:22Z",
  "orderConfirmed": true,
  "orderDisplayFinancialStatus": "PENDING",
  "orderDisplayFulfillmentStatus": "UNFULFILLED",
  "orderProcessedAt": "2019-08-24T14:15:22Z",
  "lastShippingUpdatedAt": "2019-08-24T14:15:22Z",
  "inventorySkippedAttemptCount": 0,
  "inventorySkippedRetryingNeeded": true,
  "orderAttributes": [
    { … }
  ],
  "partialLinesSkipped": "INVENTORY_MANAGEMENT",
  "orderAmountContractCurrency": 0.1
}

Skip the next upcoming order for a subscription

Request

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

Query
api_keystring

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

subscriptionContractIdinteger(int64)

Subscription Contract ID

Headers
X-API-Keystring
curl -i -X PUT \
  'https://subscription-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-upcoming-order?api_key=string&subscriptionContractId=0' \
  -H 'X-API-Key: string'

Responses

Next order successfully skipped

Bodyapplication/json
idinteger(int64)
shopstringrequired
billingAttemptIdstring
statusstring
Enum"SUCCESS""FAILURE""REQUESTING""PROGRESS""QUEUED""SKIPPED""SOCIAL_CONNECTION_NULL""CONTRACT_CANCELLED""CONTRACT_ENDED""CONTRACT_PAUSED"
billingDatestring(date-time)
contractIdinteger(int64)
attemptCountinteger(int32)
attemptTimestring(date-time)
graphOrderIdstring
orderIdinteger(int64)
orderAmountnumber(double)
orderNamestring
retryingNeededbooleanrequired
transactionFailedEmailSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED"
upcomingOrderEmailSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""STOP_FROM_CONTRACT""CONTRACT_PAUSED"
applyUsageChargeboolean
recurringChargeIdinteger(int64)
transactionRatenumber(double)
usageChargeStatusstring
Enum"SUCCESS""FAILED""TO_BE_TRIED"
transactionFailedSmsSentStatusstring
Enum"SENT""UNSENT""FAILED""SMS_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""PHONE_NUMBER_EMPTY"
upcomingOrderSmsSentStatusstring
Enum"SENT""UNSENT""FAILED""SMS_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""STOP_FROM_CONTRACT""CONTRACT_PAUSED""PHONE_NUMBER_EMPTY"
billingAttemptResponseMessagestring
progressAttemptCountinteger(int32)
orderNotestring
variantListArray of objects(VariantQuantity)
securityChallengeSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CONTRACT_CANCELLED"
orderAmountUSDnumber(double)
orderCancelReasonstring
Enum"CUSTOMER""DECLINED""FRAUD""INVENTORY""STAFF""OTHER""$UNKNOWN"
orderCancelledAtstring(date-time)
orderClosedboolean
orderClosedAtstring(date-time)
orderConfirmedboolean
orderDisplayFinancialStatusstring
Enum"PENDING""AUTHORIZED""PARTIALLY_PAID""PARTIALLY_REFUNDED""VOIDED""PAID""REFUNDED""EXPIRED""$UNKNOWN"
orderDisplayFulfillmentStatusstring
Enum"UNFULFILLED""PARTIALLY_FULFILLED""FULFILLED""RESTOCKED""PENDING_FULFILLMENT""OPEN""IN_PROGRESS""ON_HOLD""SCHEDULED""REQUEST_DECLINED"
orderProcessedAtstring(date-time)
lastShippingUpdatedAtstring(date-time)
inventorySkippedAttemptCountinteger(int32)
inventorySkippedRetryingNeededboolean
orderAttributesArray of objects(AttributeInfo)
partialLinesSkippedstring
Enum"INVENTORY_MANAGEMENT""MANUAL"
orderAmountContractCurrencynumber(double)
Response
application/json
{
  "id": 0,
  "shop": "string",
  "billingAttemptId": "string",
  "status": "SUCCESS",
  "billingDate": "2019-08-24T14:15:22Z",
  "contractId": 0,
  "attemptCount": 0,
  "attemptTime": "2019-08-24T14:15:22Z",
  "graphOrderId": "string",
  "orderId": 0,
  "orderAmount": 0.1,
  "orderName": "string",
  "retryingNeeded": true,
  "transactionFailedEmailSentStatus": "SENT",
  "upcomingOrderEmailSentStatus": "SENT",
  "applyUsageCharge": true,
  "recurringChargeId": 0,
  "transactionRate": 0.1,
  "usageChargeStatus": "SUCCESS",
  "transactionFailedSmsSentStatus": "SENT",
  "upcomingOrderSmsSentStatus": "SENT",
  "billingAttemptResponseMessage": "string",
  "progressAttemptCount": 0,
  "orderNote": "string",
  "variantList": [
    { … }
  ],
  "securityChallengeSentStatus": "SENT",
  "orderAmountUSD": 0.1,
  "orderCancelReason": "CUSTOMER",
  "orderCancelledAt": "2019-08-24T14:15:22Z",
  "orderClosed": true,
  "orderClosedAt": "2019-08-24T14:15:22Z",
  "orderConfirmed": true,
  "orderDisplayFinancialStatus": "PENDING",
  "orderDisplayFulfillmentStatus": "UNFULFILLED",
  "orderProcessedAt": "2019-08-24T14:15:22Z",
  "lastShippingUpdatedAt": "2019-08-24T14:15:22Z",
  "inventorySkippedAttemptCount": 0,
  "inventorySkippedRetryingNeeded": true,
  "orderAttributes": [
    { … }
  ],
  "partialLinesSkipped": "INVENTORY_MANAGEMENT",
  "orderAmountContractCurrency": 0.1
}

Skip a specific order

Request

Skips a specific billing attempt by ID. The order will not be processed on its scheduled date. This is useful when customers want to skip a particular delivery without canceling their subscription.

Important Behaviors:

  • Only QUEUED billing attempts can be skipped
  • Skipped orders remain in the system with SKIPPED status
  • Future orders are not affected
  • Can be unskipped before the scheduled date if needed
  • Activity logs are created for audit trail

Use Cases:

  • Customer is on vacation
  • Customer has excess inventory
  • Temporary delivery pause for one cycle

Authentication: Requires valid X-API-Key header

Path
idinteger(int64)required

Billing Attempt ID

Query
api_keystring

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

subscriptionContractIdinteger(int64)

Subscription Contract ID

isPrepaidboolean

Is this contract Prepaid?

Default false
Headers
X-API-Keystring
curl -i -X PUT \
  'https://subscription-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}?api_key=string&subscriptionContractId=0&isPrepaid=false' \
  -H 'X-API-Key: string'

Responses

Order successfully skipped

Bodyapplication/json
idinteger(int64)
shopstringrequired
billingAttemptIdstring
statusstring
Enum"SUCCESS""FAILURE""REQUESTING""PROGRESS""QUEUED""SKIPPED""SOCIAL_CONNECTION_NULL""CONTRACT_CANCELLED""CONTRACT_ENDED""CONTRACT_PAUSED"
billingDatestring(date-time)
contractIdinteger(int64)
attemptCountinteger(int32)
attemptTimestring(date-time)
graphOrderIdstring
orderIdinteger(int64)
orderAmountnumber(double)
orderNamestring
retryingNeededbooleanrequired
transactionFailedEmailSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED"
upcomingOrderEmailSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""STOP_FROM_CONTRACT""CONTRACT_PAUSED"
applyUsageChargeboolean
recurringChargeIdinteger(int64)
transactionRatenumber(double)
usageChargeStatusstring
Enum"SUCCESS""FAILED""TO_BE_TRIED"
transactionFailedSmsSentStatusstring
Enum"SENT""UNSENT""FAILED""SMS_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""PHONE_NUMBER_EMPTY"
upcomingOrderSmsSentStatusstring
Enum"SENT""UNSENT""FAILED""SMS_SETTINGS_DISABLED""CUSTOMER_PAYMENT_EMPTY""CONTRACT_CANCELLED""STOP_FROM_CONTRACT""CONTRACT_PAUSED""PHONE_NUMBER_EMPTY"
billingAttemptResponseMessagestring
progressAttemptCountinteger(int32)
orderNotestring
variantListArray of objects(VariantQuantity)
securityChallengeSentStatusstring
Enum"SENT""UNSENT""FAILED""EMAIL_SETTINGS_DISABLED""CONTRACT_CANCELLED"
orderAmountUSDnumber(double)
orderCancelReasonstring
Enum"CUSTOMER""DECLINED""FRAUD""INVENTORY""STAFF""OTHER""$UNKNOWN"
orderCancelledAtstring(date-time)
orderClosedboolean
orderClosedAtstring(date-time)
orderConfirmedboolean
orderDisplayFinancialStatusstring
Enum"PENDING""AUTHORIZED""PARTIALLY_PAID""PARTIALLY_REFUNDED""VOIDED""PAID""REFUNDED""EXPIRED""$UNKNOWN"
orderDisplayFulfillmentStatusstring
Enum"UNFULFILLED""PARTIALLY_FULFILLED""FULFILLED""RESTOCKED""PENDING_FULFILLMENT""OPEN""IN_PROGRESS""ON_HOLD""SCHEDULED""REQUEST_DECLINED"
orderProcessedAtstring(date-time)
lastShippingUpdatedAtstring(date-time)
inventorySkippedAttemptCountinteger(int32)
inventorySkippedRetryingNeededboolean
orderAttributesArray of objects(AttributeInfo)
partialLinesSkippedstring
Enum"INVENTORY_MANAGEMENT""MANUAL"
orderAmountContractCurrencynumber(double)
Response
application/json
{
  "id": 0,
  "shop": "string",
  "billingAttemptId": "string",
  "status": "SUCCESS",
  "billingDate": "2019-08-24T14:15:22Z",
  "contractId": 0,
  "attemptCount": 0,
  "attemptTime": "2019-08-24T14:15:22Z",
  "graphOrderId": "string",
  "orderId": 0,
  "orderAmount": 0.1,
  "orderName": "string",
  "retryingNeeded": true,
  "transactionFailedEmailSentStatus": "SENT",
  "upcomingOrderEmailSentStatus": "SENT",
  "applyUsageCharge": true,
  "recurringChargeId": 0,
  "transactionRate": 0.1,
  "usageChargeStatus": "SUCCESS",
  "transactionFailedSmsSentStatus": "SENT",
  "upcomingOrderSmsSentStatus": "SENT",
  "billingAttemptResponseMessage": "string",
  "progressAttemptCount": 0,
  "orderNote": "string",
  "variantList": [
    { … }
  ],
  "securityChallengeSentStatus": "SENT",
  "orderAmountUSD": 0.1,
  "orderCancelReason": "CUSTOMER",
  "orderCancelledAt": "2019-08-24T14:15:22Z",
  "orderClosed": true,
  "orderClosedAt": "2019-08-24T14:15:22Z",
  "orderConfirmed": true,
  "orderDisplayFinancialStatus": "PENDING",
  "orderDisplayFulfillmentStatus": "UNFULFILLED",
  "orderProcessedAt": "2019-08-24T14:15:22Z",
  "lastShippingUpdatedAt": "2019-08-24T14:15:22Z",
  "inventorySkippedAttemptCount": 0,
  "inventorySkippedRetryingNeeded": true,
  "orderAttributes": [
    { … }
  ],
  "partialLinesSkipped": "INVENTORY_MANAGEMENT",
  "orderAmountContractCurrency": 0.1
}

Subscription Discounts

APIs for managing discounts and promotional codes applied to subscriptions.

Operations

Subscription One-Time Products

APIs for managing one-time add-on products that can be purchased alongside recurring subscription items.

Operations

Subscription Plans

APIs for managing subscription plans, pricing tiers, and plan configurations.

Operations

Build-a-Box & Bundles

APIs for managing customizable product boxes and bundles where customers can select multiple items.

Operations

Product Catalog

APIs for managing the product catalog including product information, variants, and inventory.

Operations

Operations & Settings

APIs for managing operational settings, configurations, and administrative functions.

Operations

Customer Portal

APIs powering the customer-facing portal where subscribers can manage their own subscriptions.

Operations

Customers

APIs for managing customer information, profiles, and account details.

Operations