External APIs (0.0.1)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Updates the order note that will be added to all future orders generated by this subscription. Order notes help merchants track special instructions, customer preferences, or internal information about the subscription.

Key Features:

• Note is automatically added to all future recurring orders
• Visible in both merchant portal and customer portal
• Appears in Shopify order details for easy reference
• Changes apply to future orders only (existing orders unchanged) Common Use Cases:
• Customer preferences: "No nuts - severe allergy"
• Delivery instructions: "Leave package at side door"
• Gift messages: "Happy Birthday from Mom!"
• Internal notes: "VIP customer - priority handling"
• Processing instructions: "Include sample with each order"

Important Notes:

• Empty string clears the existing note
• No character limit imposed by API (check Shopify limits)
• HTML is not rendered - stored as plain text
• Updates are logged in activity history
• Note persists until explicitly changed

Order Generation: When Appstle creates recurring orders:

1. Retrieves current order note from subscription
2. Adds note to new Shopify order
3. Note appears in order details immediately
4. Merchants can still edit individual order notes

Authentication: Requires valid X-API-Key header

Updates the minimum number of billing cycles (orders) that a customer must complete before they can cancel their subscription. This creates a commitment period that helps with customer retention and business predictability.

What are Minimum Cycles? Minimum cycles represent a commitment period where:

• Customers must complete a specified number of orders
• Cancellation is blocked until the minimum is met
• Often tied to special pricing or promotional offers
• Counted from the subscription start date

Key Features:

• Updates commitment period for existing subscriptions
• Can increase or decrease minimum cycles
• Setting to null removes the minimum commitment
• Preserves all other subscription settings
• Automatically handles invalid discount codes
• Updates future billing queue after change

Common Use Cases:

• Promotional Offers: '3-month minimum for 50% off'
• Hardware Subsidies: '12-month commitment with free device'
• Loyalty Programs: Reduce minimum after customer proves loyalty
• Seasonal Campaigns: Temporary commitment requirements
• Contract Adjustments: Customer service exceptions

Impact on Customers:

• Cannot cancel via portal until minimum cycles complete
• Pause/resume typically still allowed (check settings)
• Shows commitment status in customer portal
• No automatic notification sent (consider sending separately)

Cycle Counting:

• Only successful billing attempts count toward minimum
• Failed payments don't increment the cycle count
• Skipped orders (if allowed) don't count
• Current cycle = successful past orders + 1

Interaction with Max Cycles:

• Min cycles must be less than or equal to max cycles
• If max cycles exist, subscription auto-cancels after maximum
• Common pattern: 3 min cycles, 12 max cycles

Best Practices:

• Clearly communicate commitment terms upfront
• Consider grandfathering existing customers
• Use reasonable minimums (typically 3-12 cycles)
• Document reason for changes in activity logs
• Send customer notification for transparency

Important Notes:

• Changes apply immediately to cancellation logic
• Doesn't affect past or in-progress orders
• Customer portal respects this setting automatically
• Activity log tracks old and new values
• Consider legal requirements in your jurisdiction

Authentication: Requires valid X-API-Key header

Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders.

What are Maximum Cycles? Maximum cycles define subscription duration limits where:

• Subscription automatically cancels after the specified number of orders
• No further orders are generated once maximum is reached
• Useful for fixed-term offers, trials, or seasonal subscriptions
• Customer is notified before final order (if configured)

Key Features:

• Cannot set below current cycle count (prevents immediate cancellation)
• Setting to null creates an indefinite subscription
• Automatically reschedules order queue based on new limit
• Preserves all other subscription settings
• Validates against current subscription progress

Current Cycle Calculation:

• Current cycle = Successful billing attempts + 1
• Failed payments don't count toward maximum
• First order is cycle 1, second is cycle 2, etc.
• System prevents setting max below current position

Common Use Cases:

• Trial Subscriptions: '3-box trial' that auto-ends
• Seasonal Programs: '6-month summer subscription'
• Limited Series: '12-issue magazine subscription'
• Promotional Offers: 'First 5 boxes at special price'
• Gift Subscriptions: Fixed duration gifts that don't renew

What Happens at Maximum: When a subscription reaches its maximum cycles:

1. Final order is processed normally
2. Subscription status changes to CANCELLED
3. No future orders are scheduled
4. Customer receives cancellation notification
5. Cannot be reactivated (new subscription required)

Interaction with Min Cycles:

• Can have both min and max (e.g., 3 min, 12 max)
• Min cycles enforces commitment period
• Max cycles enforces termination
• Common pattern: Commitment with defined end

Queue Management: After updating max cycles:

• System recalculates future order schedule
• Removes orders beyond the new maximum
• Adjusts upcoming order notifications
• Updates subscription end date projections

Important Notes:

• Validation prevents accidental immediate cancellation
• Changes apply to future billing cycles only
• Activity log tracks old and new values
• Consider customer communication for changes
• Setting null removes any duration limit

Authentication: Requires valid X-API-Key header