24/7 Support: 800.608.6482

Navigation

ProductSubscriptionTermList_Load_Query

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

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
product_id Type:
Number		 Title:
Product ID		 The id number of the product
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 customer subscription terms returned
start_offset Type:
Number		 Title:
Start Offset		 the offset starting point for pagination of return data
id Type:
Number		 Title:
ID		 customer subscription term id
product_id Type:
Number		 Title:
Product ID		 Product id associated with the subscription
frequency Type:
String		 Title:
Subscription Frequency		 The frequency of the subscription fulfillment
term Type:
Number		 Title:
Term		 Number of subscription terms
descrip Type:
String		 Title:
Frequency Description		 description of the subscription frequency
n Type:
Number		 Title:
Fulfillment N Days From Purchase		 Number of days or Months between each fulfillment. Only set if using Subscription Terms
fixed_dow Type:
Number		 Title:
Fixed Day of Week		 Number indicating a fixed day of the week for weekly subscription fulfillment
fixed_dom Type:
Number		 Title:
Fixed Day of Month		 Number indicating a fixed day of the month for monthly subscription fulfillment
sub_count Type:
Number		 Title:
Subscription Count		 Count of subscriptions with this term
dates Type:
Object		 Title:
Dates		 Array of objects containing subscription dates. See usage here: List Load Query Overview

Example Request

Example Response

Error Responses

error code:
MER-JSN-PRD-00070		 error message:
Product not found		 description:
Product not found

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 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.