Skip to content
🔧 Admin APIs
/
/
Get subscription order fu...

External (0.0.1)

Download OpenAPI description
admin-api-swagger.json
admin-api-swagger.yaml
Languages
Servers
https://membership-admin.appstle.com

Shipping & Delivery Profiles

APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships

Operations

Customer Discount History

APIs for retrieving historical discount code usage and redemption information for membership contracts

Operations

Cancellation Flow Configuration

APIs for managing membership cancellation flow settings including retention offers, survey questions, and cancel confirmation screens

Operations

Billing & Orders

APIs for managing membership billing attempts, recurring orders, payment retries, order history, and order skipping

Operations

One-Time Add-Ons

APIs for managing one-time product additions to upcoming subscription orders, including adding, retrieving, and removing one-off items

Operations

Membership Plans

APIs for managing membership/subscription plan groups, including creating plans, configuring discounts, billing intervals, and assigning products to plans

Operations

Product Bundles

APIs for managing subscription product bundles, bundle configurations, item grouping, and bundle-specific discount codes

Operations

Custom CSS Styling

APIs for retrieving custom CSS styles applied to subscription widgets and customer portal for theme customization

Operations

Customer Portal Configuration

APIs for managing customer portal settings including UI customization, text labels, feature toggles, and branding options for the member self-service portal

Operations

Membership Contracts

APIs for managing membership/subscription contracts including creation, updates, status changes, line items, discounts, and billing operations

Operations

Cancel pending downgrade for a subscription contract

Request

Cancels a scheduled/pending downgrade for a specific subscription contract. This endpoint removes the pending downgrade so that the subscription will continue with its current plan.

Important Notes:

  • The downgrade must be pending (not yet executed) to be cancelled
  • Once cancelled, the subscription will remain on its current plan
  • An activity log entry is created when a downgrade is cancelled

Use Cases:

  • Allow customers to change their mind about a scheduled downgrade
  • Cancel downgrades when customers upgrade or renew
  • Administrative cancellation of pending plan changes

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

Path
contractIdinteger(int64)required

The subscription contract ID

Example: 12345
Query
api_keystring

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

Headers
X-API-Keystring
curl -i -X DELETE \
  'https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/12345/pending-downgrade?api_key=string' \
  -H 'X-API-Key: string'

Responses

Pending downgrade cancelled successfully

Get subscription order fulfillment details

Request

Retrieves fulfillment information for the most recent order generated by a subscription contract. Shows shipping status, tracking numbers, and delivery progress.

Key Features:

  • Latest Order: Returns fulfillment data for the most recent subscription order
  • Tracking Info: Includes tracking numbers, URLs, and shipping carriers
  • Fulfillment Status: Shows whether items are unfulfilled, fulfilled, or partially fulfilled
  • Multi-Fulfillment: Handles orders split across multiple shipments

Returned Fulfillment Data:

  • Order Info: Order name/number, creation date, financial status
  • Fulfillment Status: FULFILLED, PARTIAL, UNFULFILLED, etc.
  • Fulfillments List: Array of all fulfillments for the order
  • Tracking Numbers: Tracking codes for each fulfillment
  • Tracking URLs: Direct links to carrier tracking pages
  • Shipping Carrier: Carrier name (USPS, FedEx, UPS, etc.)
  • Fulfillment Date: When each shipment was fulfilled
  • Line Items: Which products/variants are in each shipment
  • Delivery Address: Where the order is being shipped

Common Use Cases:

  • Order Tracking: Show customers where their subscription delivery is
  • Customer Portal: Display "Track Your Order" links
  • Shipping Updates: Check fulfillment status for recent orders
  • Support: Help customers track delayed or missing shipments
  • Notifications: Trigger custom shipping notifications
  • Analytics: Track fulfillment performance metrics

Response Structure: Returns an Order object containing:

  • Basic order information
  • Array of fulfillments with tracking details
  • Line items per fulfillment
  • Shipping and delivery information

Note: This returns data for the MOST RECENT order only. For historical fulfillment data, use order history endpoints.

Parameters:

  • contractId (required, path): The subscription contract ID

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

Path
contractIdinteger(int64)required

Subscription contract ID

Example: 12345
Query
api_keystring

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

Headers
X-API-Keystring
curl -i -X GET \
  'https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/subscription-fulfillments/12345?api_key=string' \
  -H 'X-API-Key: string'

Responses

Fulfillment details retrieved successfully

Bodyapplication/json
get__typenamestring
idstring
fulfillmentOrdersobject(FulfillmentOrders)
Response
application/json
{
  "get__typename": "string",
  "id": "string",
  "fulfillmentOrders": {
    "get__typename": "string",
    "nodes": [ … ],
    "pageInfo": { … }
  }
}

Get billing interval options for selling plans

Request

Retrieves available billing frequency/interval options for specified Shopify selling plans (subscription plans). This endpoint returns all configured billing frequencies that customers can choose from for their subscriptions.

Key Information Returned:

  • Frequency Options: List of available billing intervals (e.g., weekly, monthly, quarterly)
  • Interval Units: Time unit for each option (DAYS, WEEKS, MONTHS, YEARS)
  • Interval Count: Number of units between billings (e.g., 2 = every 2 weeks)
  • Display Names: Customer-friendly names for each frequency option
  • Plan IDs: Associated selling plan IDs for each frequency

Billing Frequency Structure: Each FrequencyInfoDTO contains:

  • id: Selling plan ID (Shopify subscription plan identifier)
  • name: Display name (e.g., "Deliver every 2 weeks", "Monthly subscription")
  • intervalUnit: Time unit (DAY, WEEK, MONTH, YEAR)
  • intervalCount: Number of units between deliveries
  • billingPolicy: How billing is configured (EXACT_DAY, ANNIVERSARY)
  • deliveryPolicy: How delivery is scheduled

Common Billing Intervals:

  • Weekly: intervalUnit=WEEK, intervalCount=1
  • Bi-Weekly: intervalUnit=WEEK, intervalCount=2
  • Monthly: intervalUnit=MONTH, intervalCount=1
  • Every 2 Months: intervalUnit=MONTH, intervalCount=2
  • Quarterly: intervalUnit=MONTH, intervalCount=3
  • Semi-Annual: intervalUnit=MONTH, intervalCount=6
  • Annual: intervalUnit=YEAR, intervalCount=1

Request Parameters:

  • sellingPlanIds: Comma-separated list of Shopify selling plan IDs (required)
    • Example: "123456,123457,123458"
    • Returns frequency options for all specified plans

Common Use Cases:

  • Display available billing frequencies in customer portal
  • Allow customers to change subscription delivery frequency
  • Build frequency selector UI components
  • Validate frequency options before updating subscription
  • Sync available billing options with external systems
  • Show frequency options during subscription checkout

Integration Example:

  1. Get customer's current subscription selling plan ID
  2. Call this endpoint with that selling plan ID
  3. Display returned frequency options to customer
  4. Customer selects new frequency
  5. Update subscription with selected frequency

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

Query
api_keystring

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

sellingPlanIdsstringrequired

Comma-separated list of Shopify selling plan IDs

Example: sellingPlanIds=123456,123457,123458
Headers
X-API-Keystring
curl -i -X GET \
  'https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/billing-interval?api_key=string&sellingPlanIds=123456%2C123457%2C123458' \
  -H 'X-API-Key: string'

Responses

Billing interval options successfully retrieved

Bodyapplication/json
frequencyCountinteger(int32)
frequencyIntervalstring
Enum"DAY""WEEK""MONTH""YEAR"
billingFrequencyCountinteger(int32)
billingFrequencyIntervalstring
Enum"DAY""WEEK""MONTH""YEAR"
frequencyNamestring
discountOffernumber(double)
discountOffer2number(double)
afterCycle1integer(int32)
afterCycle2integer(int32)
discountTypestring
Enum"PERCENTAGE""FIXED""PRICE"
discountType2string
Enum"PERCENTAGE""FIXED""PRICE"
discountEnabledboolean
discountEnabled2boolean
discountEnabledMaskedboolean
discountEnabled2Maskedboolean
idstring
frequencyTypestring
Enum"ON_PURCHASE_DAY""ON_SPECIFIC_DAY"
specificDayValueinteger(int32)
specificMonthValueinteger(int32)
specificDayEnabledboolean
maxCyclesinteger(int32)
minCyclesinteger(int32)
cutOffinteger(int32)
prepaidFlagstring
idNewstring
planTypestring
Enum"PAY_AS_YOU_GO""PREPAID""ADVANCED_PREPAID"
deliveryPolicyPreAnchorBehaviorstring
Enum"ASAP""NEXT""$UNKNOWN"
freeTrialEnabledboolean
freeTrialCountinteger(int32)
freeTrialIntervalstring
Enum"DAY""WEEK""MONTH""YEAR"
frequencyDescriptionstring
keepOriginalNextBillingDateAfterTrialboolean
planSequenceinteger(int32)
groupNamestring
groupIdinteger(int64)
memberOnlyboolean
nonMemberOnlyboolean
memberInclusiveTagsstring
memberExclusiveTagsstring
lifeTimeMembershipboolean
rulesJsonstring
Response
application/json
{
  "frequencyCount": 0,
  "frequencyInterval": "DAY",
  "billingFrequencyCount": 0,
  "billingFrequencyInterval": "DAY",
  "frequencyName": "string",
  "discountOffer": 0.1,
  "discountOffer2": 0.1,
  "afterCycle1": 0,
  "afterCycle2": 0,
  "discountType": "PERCENTAGE",
  "discountType2": "PERCENTAGE",
  "discountEnabled": true,
  "discountEnabled2": true,
  "discountEnabledMasked": true,
  "discountEnabled2Masked": true,
  "id": "string",
  "frequencyType": "ON_PURCHASE_DAY",
  "specificDayValue": 0,
  "specificMonthValue": 0,
  "specificDayEnabled": true,
  "maxCycles": 0,
  "minCycles": 0,
  "cutOff": 0,
  "prepaidFlag": "string",
  "idNew": "string",
  "planType": "PAY_AS_YOU_GO",
  "deliveryPolicyPreAnchorBehavior": "ASAP",
  "freeTrialEnabled": true,
  "freeTrialCount": 0,
  "freeTrialInterval": "DAY",
  "frequencyDescription": "string",
  "keepOriginalNextBillingDateAfterTrial": true,
  "planSequence": 0,
  "groupName": "string",
  "groupId": 0,
  "memberOnly": true,
  "nonMemberOnly": true,
  "memberInclusiveTags": "string",
  "memberExclusiveTags": "string",
  "lifeTimeMembership": true,
  "rulesJson": "string"
}

Bundle Settings

APIs for managing subscription bundle configuration settings including bundle behavior, pricing rules, and display options

Operations

Customer Payment Methods

APIs for managing customer payment methods, payment tokens, and payment method retrieval for subscriptions

Operations

Product Swap Rules

APIs for retrieving product swap/substitution options allowing members to exchange subscription items based on configured swap rules and variant groups

Operations

Subscription Contract Management

Operations

Subscription Billing

Operations

Billing Attempts

Operations