--- title: "Search subscriptions" method: GET path: "/subscriptions/" tags: ["Subscription"] --- # Search subscriptions `GET /subscriptions/` ## Query parameters - `CustomerEmail` string - `DeliveredCode` string - `AvangateCustomerReference` string - `ExternalCustomerReference` string - `Aggregate` boolean - `SubscriptionEnabled` boolean - `RecurringEnabled` boolean - `ProductCodes` string[] - `CountryCodes` string[] - `PurchasedAfter` string - `PurchasedBefore` string - `ExpireAfter` string - `ExpireBefore` string - `RenewedAfter` string - `RenewedBefore` string - `NotificationAfter` string - `NotificationBefore` string - `ModifiedAfter` string - `ModifiedBefore` string - `NextBillingDateAfter` string - `NextBillingDateBefore` string - `LifetimeSubscription` boolean - `Type` string - `Page` integer - `Limit` integer ## Headers - `Accept` 'application/json', required - `X-Avangate-Authentication` string, required ## Response `200` List subscriptions - InlineResponse2008 - `Items` SubscriptionResponse[] - `SubscriptionReference` string - `StartDate` string - `ActivationDate` string - `ExpirationDate` string - `RecurringEnabled` boolean - `NextBillingDate` string, required - `SubscriptionEnabled` boolean - `Product` Product - `AvangateId` integer, nullable — Unique, system-generated product ID (read-only) - `ProductCode` string — The unique product code you can define for each of your offerings - `ExternalReference` string — External reference set when defining the product - `ProductType` 'REGULAR' | 'BUNDLE' — The type of the product (REGULAR or BUNDLE) - `ProductName` string — The name of the product - `ProductVersion` string — The product version number - `ProductGroup` ProductProductGroup - `Code` string, nullable - `Description` string - `Name` string - `TemplateName` string - `PurchaseMultipleUnits` boolean — Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product - `ShippingClass` ProductsShippingClass - `Amount` string — The shipping costs - `ApplyTo` string, nullable — Possible values • PRODUCT • ORDER - `Currency` string — The currency ISO code used for shipping costs - ISO 4217. - `Name` string — The name of the shipping class - `Type` string — Possible values • FIXED • PERCENT - `GiftOption` boolean — True or false depending on whether the product can be gifted or not - `ShortDescription` string — Product's short description - `LongDescription` string — Product's long description - `SystemRequirements` string — System requirements - `ProductCategory` union — Product's category name - string - boolean - `Platforms` ProductsPlatforms[] - `Category` string, required — Platform category per product configuration. - `IdPlatform` string, required - `PlatformName` string, required — The label of the platform per the product configuration. - `ProductImages` ProductsProductImages[] - `Default` boolean — True or False depending on whether you set the image stored at the address in the URL parameter as default or not. - `URL` string — The location of the image on the 2Checkout system. - `TrialUrl` string — The URL where shoppers can download trial software from - `TrialDescription` string — Descriptive text entered for trials - `Tangible` boolean — TRUE - for physical products, FALSE - for digital products - `TangibleDetails` ProductTangibleDetails — Relevant only for tangible products; contains physical product setup information - `UnitDetails` ProductTangibleDetailsUnitDetails[] - `Type` string — Product physical configuration type - `Amount` number, float — Product's tangible configuration type value - `Fee` ProductTangibleDetailsHandlingFee[] - `Currency` string — Currency of the handling fee - `Amount` number, float — Handling fee amount defined on the tangible product - `Enabled` boolean — True/false depending on whether the products are active or disabled - `ReviewProductUrl` boolean — The URL where the product can be reviewed before approval. Required if the "Enabled" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation. - `ReviewAdditionalDetails` boolean — Additional information can be added to access the review of the product. Parameter is optional. - `AdditionalFields` ProductsAdditionalFields[] - `Code` string — The code of the additional field assigned to a product. - `Enabled` boolean — True or false depending on whether the assigned product field is enabled or not. - `Label` string — The name of the additional field assigned to a product. - `Required` boolean — True or false depending on whether the assigned product field is required or not. - `URLParameter` string — The value of the system generated URL parameter for the product field that can be used in Buy Links. - `Translations` ProductsTranslations[] - `Description` string — Localized product short description. - `Language` string — ISO 639-1 two-letter code. - `LongDescription` string — The translated long description in the language corresponding to the Translation object. - `Name` string — Localized product name. - `SystemRequirements` string, nullable — Localized system requirements. - `TrialDescription` string, nullable - `TrialUrl` string, nullable — The trial URL for users speaking the language corresponding to the Translation object. - `PricingConfigurations` ProductsPricingConfigurations[] - `BillingCountries` string[] — ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration. - `Code` string — System-generated identifier. - `Default` boolean — True for the default pricing configuration - `DefaultCurrency` string — The ISO code of the default currency for the pricing configuration - `Name` string — Pricing configuration name - `PriceOptions` ProductsPriceOptions[] - `Code` string, required — Price option identifier. - `Required` boolean, required — True or False depending on whether you want to make it mandatory for shoppers to select the price option during the purchase process. - `PriceType` string — Possible values - NET / GROSS - `Prices` ProductPricingConfigurationPrice[] - `Amount` number, required — The price of the product. - `Currency` string, required — ISO code of the currency for the product price. - `MaxQuantity` string, required — The maximum quantity of volume discounts. Default is 99999. - `MinQuantity` string, required — The minimum quantity of volume discounts. Default is 1. - `OptionCodes` unknown[], required - unknown - `PricingSchema` string — DYNAMIC – With a base price or FLAT – Without a base price - `BundleProducts` ProductBundledProducts[] - `ProductId` string — Unique, system-generated product ID - `ProductCode` string — Editable product code that you control - `Fulfillment` 'NO_DELIVERY' | 'INHERIT' | 'BY_AVANGATE' | 'BY_VENDOR' — Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY - `Prices` ProductPricingConfigurationPrice[] — to be used when Pricing Configurations are not available for your account - `Amount` number, required — The price of the product. - `Currency` string, required — ISO code of the currency for the product price. - `MaxQuantity` string, required — The maximum quantity of volume discounts. Default is 99999. - `MinQuantity` string, required — The minimum quantity of volume discounts. Default is 1. - `OptionCodes` unknown[], required - unknown - `GeneratesSubscription` boolean — TRUE or FALSE depending on whether you set the product to generate subscriptions or not - `SubscriptionInformation` ProductsSubscriptionInformation - `BillingCycle` string - `BillingCycleUnits` string — The units of the billing cycle - M for months or D for days - `BundleRenewalManagement` string — The number of subscription billing cycle units (months or days). Possible values - 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max) - `ContractPeriod` ProductsSubscriptionInformationContractPeriod - `Action` string — The action performed after the subscription expires. Possible values CANCEL | RESTART - `EmailsDuringContract` boolean — True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not. - `IsUnlimited` boolean — This flag is true if the contract is for an unlimited period - `Period` number — The contract period in months or days. -1 for unlimited contracts. - `PeriodUnits` string, nullable — The contract period units - days | months - `DeprecatedProducts` string[] - `GracePeriod` ProductsSubscriptionInformationGracePeriod - `IsUnlimited` boolean — TRUE or FALSE depending on whether you set the grace period to unlimited or not. - `Period` string — Number of days set for the grace period. - `PeriodUnits` string — D - Days. - `Type` string — CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply. - `IsOneTimeFee` boolean — True or False depending on whether the subscription is evergreen or not. - `RenewalEmails` ProductsSubscriptionInformationRenewalEmails - `Settings` ProductsSubscriptionInformationRenewalEmailsSettings - `AutomaticRenewal` ProductsSubscriptionInformationRenewalEmailsSettingsAutomaticRenewal - … - `ManualRenewal` ProductsSubscriptionInformationRenewalEmailsSettingsAutomaticRenewal - … - `Type` string — GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings - `UsageBilling` number - `FulfillmentInformation` ProductsFulfillmentInformation - `AdditionalInformationByEmail` string — The text you set up in the Additional fulfillment information - by email area. - `AdditionalInformationEmailTranslations` ProductsFulfillmentInformationAdditionalInformationEmailTranslations[] - `Description` string — Array of localized Additional fulfillment information - "Thank you" page texts. - `Language` string - `Name` string, nullable - `AdditionalThankYouPage` string — The text you set up in the Additional fulfillment information - "Thank you" page area. - `AdditionalThankYouPageTranslations` ProductsFulfillmentInformationAdditionalInformationEmailTranslations[] - `Description` string — Array of localized Additional fulfillment information - "Thank you" page texts. - `Language` string - `Name` string, nullable - `BackupMedia` ProductsFulfillmentInformationBackupMedia - `Code` string — The unique code list identifier. - `Name` string — Name of the code list. - `Type` string — Code list type Static or Dynamic - `CodeList` ProductsFulfillmentInformationBackupMedia - `Code` string — The unique code list identifier. - `Name` string — Name of the code list. - `Type` string — Code list type Static or Dynamic - `IsBackupMedia` boolean — True or False. Depending on whether you configure the delivery of backup media or not. - `IsDisplayInPartnersCPanel` boolean — True or False. Depending on whether you share access to the product file with your channel partners or not. - `IsDownloadInsuranceService` boolean — True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file. - `IsDownloadLink` boolean — True or False. Depending on whether you configure the delivery of a product file or not. - `IsElectronicCode` boolean — True or False. Depending on whether you configure the delivery of keys/codes for the product or not. - `IsInstantDeliveryThankYouPage` boolean - `IsStartAfterFulfillment` boolean — True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not. - `ProductFile` ProductsFulfillmentInformationProductFile - `Code` string — Unique product file identifier. - `File` string — Name of the product file. - `LastUpdate` string — YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file. - `Name` string — Display name. - `Size` string — File size. - `Type` string — File type. - `Version` string — File version. - `EndUser` EndUser - `FirstName` string - `LastName` string - `Email` string - `Company` string - `FiscalCode` string - `Phone` string - `Fax` string - `Address1` string - `Address2` string - `Zip` string - `City` string - `State` string - `CountryCode` string - `Language` string - `SKU` string - `DeliveryInfo` DeliveryInfo - `Description` string - `Codes` DeliveryInfoCode[] - `Code` string - `File` string - `Description` string - `ExtraInfo` string - `ReceiveNotifications` boolean - `Lifetime` boolean - `PartnerCode` string - `ReasonText` string - `IdAffiliate` integer - `CustomerReference` string - `ExternalCustomerReference` string - `TestSubscription` boolean - `IsTrial` boolean - `Status` string - `LatestSubscriptionOrder` LatestSubscriptionOrder - `RefNo` integer - `Status` string - `FailedRecurringChargesCount` integer - `IsAssistedSale` boolean - `Billing` object - `Quantity` integer - `Currency` string - `UnitBillingPriceNet` number - `UnitBillingPriceGross` number - `BillingPriceNet` number - `BillingPriceGross` number - `NoOfBillingCycles` integer - `CurrentBillingCycle` integer - `PayedBillingCycles` integer - `RemainingBillingCycles` integer - `CurrentBillingCycleEndDate` string - `TaxAmount` number - `TaxPercent` number - `BillingCyclesFrequency` integer - `BillingCycleFrequencyUnit` string - `ContractLength` string, nullable - `ContractLengthUnit` string - `PriceOptions` object[] - `Code` string - `Options` object[] - `Value` string - `ActivationKey` string, nullable - `Pagination` Pagination - `Page` integer - `Limit` integer - `Count` integer --- [API](https://skmtc.dev/2checkout/apis/api-rest-documentation.md) · [All operations](https://skmtc.dev/2checkout/apis/api-rest-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/2checkout/api-rest-documentation/revisions/8a7ea610933e/schema)