24/7 Support: 800.608.6482

Navigation


CustomerSubscriptionList_Load_Query

This function loads a list of Customer Subscriptions.

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:
Customer Subscription List Load Query
The name of the function being executed
customer_id Type:
Number
Title:
Customer Id
The id number of the customer
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

The data structure of the `firstdate` object below is repeated in `lastdate`, `nextdate`, `cncldate`, `lastafail`.
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 subscriptions returned
start_offset Type:
Number
Title:
Start Offset
the offset starting point for pagination of return data
id Type:
Number
Title:
ID
customer subscription item id
order_id Type:
Number
Title:
Order ID
order id associated with the customer subscription
line_id Type:
Number
Title:
Line ID
line id of the subscription
cust_id Type:
Number
Title:
Customer ID
customer id for the subscription
custpc_id Type:
Number
Title:
Customer Payment Card ID
the id of the saved card linked to the subscription
product_id Type:
Number
Title:
Product ID
product id for the subscription
subterm_id Type:
Number
Title:
Subscription Term ID
subscription term id for the subscription terms
addr_id Type:
Number
Title:
Address ID
address id for the subscription
ship_id Type:
Number
Title:
Shipping ID
shipping id for the subscription
ship_data Type:
String
Title:
Shipping Data
The name of the shipping option for the subscription
quantity Type:
Number
Title:
Quantity
product quantity for the subscription
termrem Type:
Number
Title:
Terms Remaining
Number of terms remaining for the subscription
termproc Type:
Number
Title:
Terms Processed
Number of terms processed on the subscription
firstdate
+ Show Properties
Type:
Object
Title:
firstdate
Subscription first fulfillment date
time_t Type:
Number
Title:
Time_t
Unix timestamp for the first subscription fulfillment date
year Type:
Number
Title:
Year
Year of the fullfillment date
month Type:
Number
Title:
Month
Month of the fullfillment date
day Type:
Number
Title:
Day
Day of the fullfillment date
hour Type:
Number
Title:
Hour
Hour of the fullfillment date
minute Type:
Number
Title:
Minute
Minute of the fullfillment date
second Type:
Number
Title:
Second
Second of the fullfillment date
timezone Type:
Number
Title:
Time Zone
Time zone of the fullfillment date
status Type:
String
Title:
Status
Subscription status
message Type:
String
Title:
Message
Subscription status message
tax Type:
Number
Title:
Tax
Tax for the subscription
formatted_tax Type:
String
Title:
Currency Formatted Tax
Currency formatted subscription tax
shipping Type:
Number
Title:
Shipping
Shipping total for the subscription
formatted_shipping Type:
String
Title:
Currency Formatted Subscription Shipping
Currency formatted shipping total
subtotal Type:
Number
Title:
Subtotal
Subscription subtotal
formatted_subtotal Type:
String
Title:
Currency Formatted Subtotal
Currency formatted subtotal
total Type:
Number
Title:
Subscription Total
Subscription total price
formatted_total Type:
String
Title:
Currency Formatted Subscription Total
Currency formatted subscription total price
authfails Type:
Number
Title:
Authorization Failures
Number of times payment authorizaton has failed
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
subscription count
method Type:
String
Title:
Shipping Method
Shipping method for the subscription
product_code Type:
String
Title:
Product Code
Product code of the item
product_name Type:
String
Title:
Product Name
Product name of the item
product_sku Type:
String
Title:
Product SKU
Product sku of the item
product_price Type:
Number
Title:
Product Price
Product price of the item
product_formatted_price Type:
String
Title:
Currency Formatted Product Price
Currency formatted product price
product_cost Type:
Number
Title:
Product Cost
Product cost of the item
product_formatted_cost Type:
String
Title:
Currency Formatted Product Cost
Currency formatted product cost
product_weight Type:
Number
Title:
Product Weight
Product weight of the item
product_taxable Type:
Boolean
Title:
Product Taxable
Boolean value indicating if the item is taxable
product_thumbnail Type:
String
Title:
Product Thumbnail
filepath name of the product thumbnail image
product_image Type:
String
Title:
Product Image
filepath name of the product image
product_active Type:
Boolean
Title:
Status Response
Boolean value indicating if the product is active
product_dt_created Type:
Number
Title:
Product Date Created
Unix timestamp for the product creation date
product_dt_updated Type:
Number
Title:
Product Date Updated
Unix timestamp for the product update date
product_page_title Type:
String
Title:
Product Page Title
The title of the product page
product_page_id Type:
Number
Title:
Product Page ID
The Id of the product page
product_page_code Type:
String
Title:
Product Page Code
The code of the product page
product_cancat_id Type:
Number
Title:
Product Canonical Category ID
Canonical category id for the product
product_cancat_code Type:
String
Title:
Product Canonical Category Code
Canonical Category Code for the Product
product_inventory_active Type:
Boolean
Title:
Product Inventory Active
Boolean value indicating if the product inventory is active
product_inventory Type:
Number
Title:
Product Inventory
Product inventory count
paymentcard_lastfour Type:
String
Title:
Payment Card Last Four
Last four numbers of the payment card
paymentcard_type Type:
String
Title:
Payment Card Type
The type of payment card being used on the subscription
address_descrip Type:
String
Title:
Address Subscription
The address subscription
address_fname Type:
String
Title:
Address First Name
First name for the subscription address
address_lname Type:
String
Title:
Address Last Name
Last name for the subscription address
address_email Type:
String
Title:
Email Address
Email address for the subscription
address_comp Type:
String
Title:
Computer Address
IP address for the computer that made the subscription
address_phone Type:
String
Title:
Address Phone
Phone number for the subscription address field
address_fax Type:
String
Title:
Address Fax
Fax number for the subscription address field
address_addr Type:
String
Title:
Address
Street address for the subscription
address_addr1 Type:
String
Title:
Address 1
Additional street address field for the subscription
address_addr2 Type:
String
Title:
Address 2
Additional street address field for the subscription
address_city Type:
String
Title:
Address City
City for the subscription street address
address_state Type:
String
Title:
Address State
State for the subscription street address
address_zip Type:
String
Title:
Address Zip Code
Zip code for the subscription street address
address_cntry Type:
String
Title:
Address Country
Country for the subscription street address
address_resdntl Type:
Boolean
Title:
Residential Address
Boolean value indicating if the subscription address is residential
customer_login Type:
String
Title:
Customer Login
Login name for the customer having the subscription
customer_pw_email Type:
String
Title:
Customer Password Email
Email address associated with the password for the customer login
customer_business_title Type:
String
Title:
Customer Business Title
The business title of the customer
options Type:
Object
Title:
Options
Array of objects containing options. See usage here: List Load Query Overview

Example Request

Example Response

Error Responses

error code:
MER-CUS-JSN-00001
error message:
Customer not found
description:
Customer 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 – 2021 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.