Get delivery options for subscription contract

Retrieves all valid delivery methods available for a specific subscription contract. Returns shipping profiles and delivery options based on the contract’s delivery address and product characteristics.

Full behavior, validation rules, and side effects

Delivery Information Returned:

• Available shipping profiles
• Delivery methods for each profile
• Shipping rates and costs
• Delivery speed (standard, express, etc.)
• Method names and descriptions
• Eligibility based on address and products

Filtering Behavior: By default, returns only delivery methods valid for the contract:

• Matches delivery address country/region
• Compatible with subscription products
• Available for contract weight/dimensions

Include All Methods: Use header X-Include-All-Methods: true to return all delivery methods regardless of eligibility. Useful for admin UIs where you want to show all options.

Use Cases:

• Display delivery method selector in customer portal
• Allow customers to change shipping method
• Calculate shipping costs for subscription
• Validate delivery method during subscription updates
• Show upgrade options (standard to express)

Common Scenarios:

Customer Portal - Change Delivery Speed:

1. Call this endpoint with contractId
2. Display available methods to customer
3. Customer selects preferred method
4. Update subscription with new delivery method ID

Subscription Creation - Delivery Selection:

1. Get delivery options for draft contract
2. Present options during checkout/signup
3. Create subscription with selected method

Important Notes:

• Delivery options depend on current contract address
• Changing address may change available methods
• Costs may vary based on products in subscription
• Some methods may have minimum order requirements
• International shipping may have additional restrictions

Authentication: Requires X-API-Key header

GET /subscriptions/cp/api/data/contract-delivery-options

Get delivery options for subscription contract

cURL

curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/data/contract-delivery-options

200

[
  {
    "profileId": 12345,
    "profileName": "Standard Shipping",
    "methods": [
      {
        "id": "method_123",
        "name": "Standard Delivery (5-7 days)",
        "code": "STANDARD",
        "price": "5.99",
        "currency": "USD"
      },
      {
        "id": "method_124",
        "name": "Express Delivery (2-3 days)",
        "code": "EXPRESS",
        "price": "12.99",
        "currency": "USD"
      }
    ]
  }
]

Headers

X-Include-All-Methods · string

Query Parameters

contractId · integer<int64> · required

Response

200

application/json

Delivery options retrieved successfully