Update delivery interval for subscription contract

Changes the delivery/shipping frequency of a subscription contract. This allows customers to modify how often they receive their subscription orders.

Full behavior, validation rules, and side effects

Key Features:

• Flexible Delivery: Change delivery frequency (daily, weekly, monthly, yearly)
• Custom Intervals: Set custom interval counts (e.g., every 2 weeks, every 3 months)
• Independent from Billing: Delivery interval can differ from billing interval
• Immediate Effect: Changes apply to the next delivery cycle
• Activity Logging: All changes are logged for audit trail

Delivery Interval Options:

• DAY: Daily delivery (intervalCount: how many days)
• WEEK: Weekly delivery (intervalCount: how many weeks)
• MONTH: Monthly delivery (intervalCount: how many months)
• YEAR: Yearly delivery (intervalCount: how many years)

Common Examples:

• intervalCount=1, interval=MONTH: Deliver monthly
• intervalCount=2, interval=WEEK: Deliver every 2 weeks
• intervalCount=3, interval=MONTH: Deliver quarterly
• intervalCount=1, interval=WEEK: Deliver weekly
• intervalCount=6, interval=MONTH: Deliver twice a year

Billing vs. Delivery Intervals: These can be different! For example:

• Bill monthly, deliver weekly: Customer pays monthly but receives weekly shipments
• Bill quarterly, deliver monthly: Customer pays every 3 months but receives monthly shipments
• Bill annually, deliver monthly: Customer pays yearly upfront for monthly deliveries

Common Use Cases:

• Customer wants deliveries less frequently (save on shipping)
• Customer wants deliveries more frequently (use products faster)
• Adjust delivery to match consumption rate
• Seasonal frequency changes (more in summer, less in winter)
• Align deliveries with schedule (delivery when home from vacation)

Important Notes:

• Billing Date Unchanged: Only affects delivery schedule, not billing schedule
• Next Delivery Date: System recalculates next delivery date based on new interval
• Order Fulfillment: Each delivery creates a new order at the specified interval
• Prepaid Memberships: Particularly useful for prepaid plans with multiple deliveries

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

PUT /api/external/v2/subscription-contracts-update-delivery-interval

Update delivery interval for subscription contract

cURL

curl --request PUT \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-delivery-interval

200

{
  "get__typename": "<string>",
  "id": "<string>",
  "createdAt": {},
  "updatedAt": {},
  "nextBillingDate": {},
  "deliveryPrice": {
    "get__typename": "<string>",
    "amount": {}
  },
  "billingPolicy": {
    "get__typename": "<string>",
    "intervalCount": 123,
    "anchors": [
      {
        "get__typename": "<string>",
        "cutoffDay": 123,
        "day": 123,
        "month": 123
      }
    ],
    "maxCycles": 123,
    "minCycles": 123
  },
  "deliveryPolicy": {
    "get__typename": "<string>",
    "intervalCount": 123,
    "anchors": [
      {
        "get__typename": "<string>",
        "cutoffDay": 123,
        "day": 123,
        "month": 123
      }
    ]
  },
  "lines": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>"
      }
    ],
    "pageInfo": {
      "get__typename": "<string>",
      "hasPreviousPage": true,
      "hasNextPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "customerPaymentMethod": {
    "get__typename": "<string>",
    "id": "<string>",
    "instrument": {
      "get__typename": "<string>"
    },
    "revokedAt": {}
  },
  "deliveryMethod": {
    "get__typename": "<string>",
    "id": "<string>",
    "serviceCode": "<string>",
    "minDeliveryDateTime": {},
    "maxDeliveryDateTime": {},
    "additionalInformation": {
      "get__typename": "<string>",
      "instructions": "<string>"
    },
    "brandedPromise": {
      "get__typename": "<string>",
      "handle": "<string>",
      "name": "<string>"
    }
  },
  "originOrder": {
    "get__typename": "<string>",
    "id": "<string>",
    "name": "<string>",
    "fulfillmentOrders": {
      "get__typename": "<string>",
      "nodes": [
        {
          "get__typename": "<string>"
        }
      ],
      "pageInfo": {
        "get__typename": "<string>",
        "hasPreviousPage": true,
        "hasNextPage": true,
        "startCursor": "<string>",
        "endCursor": "<string>"
      }
    }
  },
  "customer": {
    "get__typename": "<string>",
    "id": "<string>",
    "email": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>"
  },
  "discounts": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>",
        "createdAt": {},
        "deliveredAt": {},
        "estimatedDeliveryAt": {},
        "id": "<string>",
        "inTransitAt": {},
        "name": "<string>",
        "requiresShipping": true,
        "service": {
          "get__typename": "<string>",
          "handle": "<string>",
          "serviceName": "<string>"
        },
        "trackingInfo": [
          {
            "get__typename": "<string>",
            "url": {},
            "number": "<string>",
            "company": "<string>"
          }
        ]
      }
    ],
    "pageInfo": {
      "get__typename": "<string>",
      "hasPreviousPage": true,
      "hasNextPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "note": "<string>",
  "customAttributes": [
    {
      "get__typename": "<string>",
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "billingAttempts": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>",
        "completedAt": {},
        "createdAt": {},
        "id": "<string>",
        "idempotencyKey": "<string>",
        "ready": true
      }
    ]
  }
}

Headers

X-API-Key · string

Query Parameters

contractId · integer<int64> · required

Subscription contract ID

api_key · string

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

deliveryIntervalCount · string · required

Number of intervals between deliveries

deliveryInterval · enum<string> · required

Delivery interval unit

Available options: DAY, WEEK, MONTH, YEAR

Response

200

application/json

Delivery interval successfully updated

get__typename · string

id · string

createdAt · object

updatedAt · object

nextBillingDate · object

status · enum<string>

Available options: ACTIVE, PAUSED, CANCELLED, EXPIRED, FAILED, $UNKNOWN

deliveryPrice · object

Show child attributes

lastPaymentStatus · enum<string>

Available options: SUCCEEDED, FAILED, $UNKNOWN

billingPolicy · object

Show child attributes

deliveryPolicy · object

Show child attributes

lines · object

Show child attributes

customerPaymentMethod · object

Show child attributes

deliveryMethod · object

Show child attributes

originOrder · object

Show child attributes

customer · object

Show child attributes

discounts · object

Show child attributes

note · string

customAttributes · object[]

Show child attributes

billingAttempts · object

Show child attributes