Get one-time add-ons for a membership contract

Retrieves all one-time product additions scheduled for upcoming orders of a specific membership contract. One-offs are products added to a single billing cycle without affecting the recurring subscription items.

Full behavior, validation rules, and side effects

Key Information Returned:

• One-Off Items: List of products added to upcoming orders
• Product Details: Variant ID, handle, title, price, image
• Billing Association: Which billing attempt the item is added to
• Quantity: Number of units for the one-time add-on
• Status: Active, pending, or fulfilled one-offs
• Created Date: When the one-off was added

One-Off Item Data:

• Contract ID: Parent subscription contract
• Billing Attempt ID: Specific order the item will be added to
• Variant Info: Product variant being added
• Pricing: One-time price for the add-on
• Fulfillment Status: Whether item has been shipped

Use Cases:

• Display scheduled one-time add-ons in customer portal
• Show customers which extra items are in next order
• Sync one-off data with external order management systems
• Generate custom order previews for customers
• Build upsell dashboards showing add-on purchases
• Track one-time product revenue per contract

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

GET /api/external/v2/subscription-contract-one-offs-by-contractId

Get one-time add-ons for a membership contract

cURL

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId

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

Response

200

application/json

One-off items successfully retrieved

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