Get billing interval options for selling plans

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.

Full behavior, validation rules, and side effects

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

GET /api/external/v2/subscription-contract-details/billing-interval

Get billing interval options for selling plans

cURL

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/billing-interval

200

{
  "frequencyCount": 123,
  "billingFrequencyCount": 123,
  "frequencyName": "<string>",
  "discountOffer": 123,
  "discountOffer2": 123,
  "afterCycle1": 123,
  "afterCycle2": 123,
  "discountEnabled": true,
  "discountEnabled2": true,
  "discountEnabledMasked": true,
  "discountEnabled2Masked": true,
  "id": "<string>",
  "specificDayValue": 123,
  "specificMonthValue": 123,
  "specificDayEnabled": true,
  "maxCycles": 123,
  "minCycles": 123,
  "cutOff": 123,
  "prepaidFlag": "<string>",
  "idNew": "<string>",
  "freeTrialEnabled": true,
  "freeTrialCount": 123,
  "frequencyDescription": "<string>",
  "keepOriginalNextBillingDateAfterTrial": true,
  "planSequence": 123,
  "groupName": "<string>",
  "groupId": 123,
  "memberOnly": true,
  "nonMemberOnly": true,
  "memberInclusiveTags": "<string>",
  "memberExclusiveTags": "<string>",
  "lifeTimeMembership": true,
  "rulesJson": "<string>",
  "allowedForUpgradeDowngrade": true
}

Headers

X-API-Key · string

Query Parameters

api_key · string

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

sellingPlanIds · string · required

Comma-separated list of Shopify selling plan IDs

Response

200

application/json

Billing interval options successfully retrieved

frequencyCount · integer<int32>

frequencyInterval · enum<string>

Available options: DAY, WEEK, MONTH, YEAR

billingFrequencyCount · integer<int32>

billingFrequencyInterval · enum<string>

Available options: DAY, WEEK, MONTH, YEAR

frequencyName · string

discountOffer · number<double>

discountOffer2 · number<double>

afterCycle1 · integer<int32>

afterCycle2 · integer<int32>

discountType · enum<string>

Available options: PERCENTAGE, FIXED, PRICE

discountType2 · enum<string>

Available options: PERCENTAGE, FIXED, PRICE

discountEnabled · boolean

discountEnabled2 · boolean

discountEnabledMasked · boolean

discountEnabled2Masked · boolean

id · string

frequencyType · enum<string>

Available options: ON_PURCHASE_DAY, ON_SPECIFIC_DAY

specificDayValue · integer<int32>

specificMonthValue · integer<int32>

specificDayEnabled · boolean

maxCycles · integer<int32>

minCycles · integer<int32>

cutOff · integer<int32>

prepaidFlag · string

idNew · string

planType · enum<string>

Available options: PAY_AS_YOU_GO, PREPAID, ADVANCED_PREPAID

deliveryPolicyPreAnchorBehavior · enum<string>

Available options: ASAP, NEXT, $UNKNOWN

freeTrialEnabled · boolean

freeTrialCount · integer<int32>

freeTrialInterval · enum<string>

Available options: DAY, WEEK, MONTH, YEAR

frequencyDescription · string

keepOriginalNextBillingDateAfterTrial · boolean

planSequence · integer<int32>

groupName · string

groupId · integer<int64>

memberOnly · boolean

nonMemberOnly · boolean

memberInclusiveTags · string

memberExclusiveTags · string

lifeTimeMembership · boolean

rulesJson · string

allowedForUpgradeDowngrade · boolean