24/7 Support: 800.608.6482

Navigation


ProductAndSubscriptionTermList_Load_Query

This function loads a list of product subscription terms for a specific product.

Request Parameters

store_code Type:
String
Title:
Store Code
Store code to run the function against. Found in the Miva Admin under Settings > Store Details
function Type:
String
Title:
Product And Subscription Term List Load Query
The name of the function being executed
filter Type:
Object
Title:
Filter
Array of objects containing search filters. See usage here: List Load Query Overview
sort Type:
String
Title:
Sort
The order for sorting any returned data
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
count Type:
Number
Title:
Count
Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
total_count Type:
Number
Title:
Total Count
the number of subscription terms returned for the product
start_offset Type:
Number
Title:
Start Offset
the offset starting point for pagination of return data
id Type:
Number
Title:
Product ID
Product id of the item
code Type:
String
Title:
Product Code
Product code of the item
sku Type:
String
Title:
Product SKU
Product sku of the item
name Type:
String
Title:
Product Name
Product name of the item
thumbnail Type:
String
Title:
Product Thumbnail
filepath name of the product thumbnail image
image Type:
String
Title:
Product Image
filepath name of the product image
price Type:
Number
Title:
Subscription Price
Subscription total price
formatted_price Type:
String
Title:
Currency Formatted Subscription Price
Currency formatted subscription price
cost Type:
Number
Title:
Product Cost
Product cost of the item
formatted_cost Type:
String
Title:
Currency Formatted Product Cost
Currency formatted product cost
weight Type:
Number
Title:
Product Weight
Product weight of the item
taxable Type:
Boolean
Title:
Product Taxable
Boolean value indicating if the item is taxable
active Type:
Boolean
Title:
Status Response
Boolean value indicating if the product is active
page_title Type:
String
Title:
Product Page Title
The title of the product page
dt_created Type:
Number
Title:
Product Date Created
Unix timestamp for the product creation date
dt_updated Type:
Number
Title:
Product Date Updated
Unix timestamp for the product update date
term_id Type:
Number
Title:
Subscription Term ID
subscription term id for the subscription terms
term_frequency Type:
String
Title:
Subscription Term Frequency
The frequency of the subscription fulfillment
term_term Type:
Number
Title:
Term of Term
Number of subscription terms for the specific term
term_descrip Type:
String
Title:
Term Frequency Description
description of the term subscription frequency
term_n Type:
Number
Title:
Term Fulfillment N Days From Purchase
Number of days or Months between each fulfillment. Only set if using Subscription Terms
term_fixed_dow Type:
Number
Title:
Term Fixed Day of Week
Number indicating a fixed day of the week for term weekly subscription fulfillment
term_fixed_dom Type:
Number
Title:
Term Fixed Day of Month
Number indicating a fixed day of the month for term monthly subscription fulfillment
term_sub_count Type:
Number
Title:
Term Subscription Count
Term subscription count

Example Request

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2021 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.