Remove one-time product from upcoming order

Removes a previously added one-time product (one-off) from a specific upcoming billing attempt. This allows customers or merchants to cancel add-on items before the order is processed.

Full behavior, validation rules, and side effects

Key Features:

• Flexible Cancellation: Remove add-ons before order processes
• Targeted Removal: Remove specific variant from specific order
• No Subscription Impact: Doesn’t affect recurring items
• Customer Control: Let members manage their add-ons
• Activity Logging: Tracks removal for audit trail

Required Parameters:

• Contract ID: Target subscription contract
• Billing Attempt ID: Order to remove item from
• Variant ID: Product variant to remove

How It Works:

1. Validates contract exists and belongs to shop
2. Finds one-off matching contract, billing attempt, and variant
3. Deletes the one-off record
4. Returns updated list of remaining one-offs
5. Logs removal activity for audit trail

Use Cases:

• Customer changes mind about add-on product
• Remove out-of-stock items from upcoming orders
• Cancel promotional items no longer available
• Customer wants to reduce order total
• Merchant corrects mistakenly added items
• Manage add-ons in customer portal

Business Rules:

• Can only remove from upcoming (unprocessed) orders
• Must match exact contract, billing attempt, and variant
• Returns remaining one-offs after deletion
• Cannot remove from past/completed orders

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

DELETE /api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id

Remove one-time product from upcoming order

cURL

curl --request DELETE \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id

200

[
  {
    "shop": "my-store.myshopify.com",
    "id": 789,
    "billingAttemptId": 123,
    "subscriptionContractId": 123,
    "variantId": 123,
    "variantHandle": "<string>"
  }
]

Headers

X-API-Key · string

Query Parameters

api_key · string

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

contractId · integer<int64> · required

Subscription contract ID

billingAttemptId · integer<int64> · required

Billing attempt ID to remove the item from

variantId · integer<int64> · required

Product variant ID to remove

Response

200

application/json

One-off product successfully removed, returns updated list of remaining one-offs

shop · string · required

Shop domain identifier

Example:

"my-store.myshopify.com"

id · integer<int64>

Unique identifier of the one-off item

Example:

789

billingAttemptId · integer<int64>

Associated billing attempt ID

subscriptionContractId · integer<int64>

Associated subscription contract ID

variantId · integer<int64>

Shopify product variant ID of the one-off item

variantHandle · string

Product variant handle for the one-off item