--- title: "Gets a list of subscription billing options and related data from active subscriptions" method: GET path: "/ocapi/v1/subscription-billing-options" tags: ["Subscriptions"] --- # Gets a list of subscription billing options and related data from active subscriptions `GET /ocapi/v1/subscription-billing-options` Billing options of inactive subscriptions are not returned, as they can not be purchased. #### Licenses Required - Vista.Ocapi - Vista.Subscriptions ## Headers - `Connect-Region-Code` string ## Response `200` Success - OcapiV1SalesMasterDataSubscriptionBillingOptionsSubscriptionBillingOptionListDetails — Represents a list of subscription billing option entities, and their related data - `billingOptions` OcapiV1SalesMasterDataSubscriptionBillingOptionsSubscriptionBillingOption[], required — Gets the list of subscription billing option entities - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `description` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `shortName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `prices` OcapiV1SalesMasterDataSubscriptionBillingOptionsSubscriptionBillingOptionPrice[], required — Gets the list of subscription billing option price entities - `price` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value - `valueIncludingTax` number, double, required — Gets the monetary value including tax - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax - `tax` number, double, required — Gets the amount of tax - `isDefault` boolean, required — Gets a value indicating whether this is the default price - `discount` OcapiV1SalesMasterDataPricesPriceDiscount — Represents the calculation logic and savings associated with a discounted price - `calculation` union, required — Represents the base properties that describe the calculation of a discount - OcapiV1DiscountCalculationsPercentageOffDiscountCalculation — Represents a percentage-off type of discount calculation base - `percentageOff` number, double, required — Gets the percentage off the default price, e.g. 12.5% off - `type` 'SpecialPrice' | 'PercentageOff' | 'PriceOff', required — Represents the type of a discount calculation base - OcapiV1DiscountCalculationsPriceOffDiscountCalculation — Represents a price-off type of discount calculation base - `priceOff` number, double, required — Gets the value of the discount off the default price, e.g. $2.00 off - `type` 'SpecialPrice' | 'PercentageOff' | 'PriceOff', required — Represents the type of a discount calculation base - OcapiV1DiscountCalculationsSpecialPriceDiscountCalculation — Represents a special-price type of discount calculation base - `specialPrice` number, double, required — Gets the value of the special price defined by the discount, e.g. now $1.50 - `type` 'SpecialPrice' | 'PercentageOff' | 'PriceOff', required — Represents the type of a discount calculation base - `amountSaved` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value - `valueIncludingTax` number, double, required — Gets the monetary value including tax - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax - `tax` number, double, required — Gets the amount of tax - `restrictions` OcapiV1SalesMasterDataSubscriptionBillingOptionsSubscriptionBillingOptionPriceRestriction[], required - `discountId` string, nullable — Gets the unique identifier of the discount that the price is restricted to - `subscriptionId` integer, required — Gets the unique identifier of the subscription - `billingPeriodInMonths` integer, required — Gets the number of months between billing cycles - `isRecurring` boolean, required — Gets a value indicating whether the billing option is purchased once or if payment is regularly taken after purchase - `relatedData` OcapiV1SalesMasterDataSubscriptionBillingOptionsSubscriptionBillingOptionListRelatedData, required — Related data for a list of subscription billing option entities - `subscriptions` OcapiV1LoyaltyMasterDataSubscriptionsSubscription[], required — Gets the list of related subscription entities - `id` integer, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `clubId` integer, required — Gets the unique identifier of the club - `minimumTermInMonths` integer, required — Gets the minimum number of number of months required for the subscription term - `minimumTermBeforeCanPurchaseFutureSubscriptionInMonths` integer, required — Gets the minimum number of months that must be completed before purchase of another subscription will be allowed - `discounts` OcapiV1SalesMasterDataDiscountsDiscount[], required — Gets the list of related discount entities - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `restriction` 'None' | 'Multiple' | 'MemberReward' | 'Voucher' | 'Availability', required — Represents the restriction options for a discount - `restrictions` OcapiV1SalesMasterDataDiscountsDiscountRestriction[], required — Gets the restrictions - `rewardIds` integer[], required — Gets the list of unique identifiers of the reward entities that the discount is restricted to - `voucherTypeCodes` string[], required — Gets the list of unique identifiers of the voucher types that the discount is restricted to - `expiresAt` string, date-time, required — Gets the date and time that the discount expires --- [API](https://skmtc.net/vista/apis/vista-digital-platform.md) · [All operations](https://skmtc.net/vista/apis/vista-digital-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vista/vista-digital-platform/revisions/3a81c0aed14e/schema)