Query subscription contract list

Requires read_subscription_contracts access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/subscription/contract.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

after string
[]
After a certain cursor , the value can be orderId , contractId , etc . , according to the specific api to indicate the specific business data id , before and after to only allow one to have value .
before string
[]
Before , the value could be orderId , contractId , etc . according to the specific api , it means that the specific business data id , before and after only allow one to have value .
created_at_max string
[]
Subscription contract production time ( end ) ( format see IOS8601 )
created_at_min string
[]
Subscription contract production time ( start ) ( format see IOS8601 )
first integer
[]
The front n elements of return support up to 50 , and the last must and only one cannot be empty
ids array
[]
Contract id list
[]
Example: ``
last integer
[]
Return last n elements , maximum support 50 , must be with first and only one cannot be empty
next_billing_date_at_max string
[]
Subscribe to next bill-generation time ( end ) ( format see IOS8601 )
next_billing_date_at_min string
[]
Subscribe to next bill generation time ( start ) ( format see IOS8601 )
reverse boolean
[]
Sort inversion
status array
[]
Subscription contract status ( ACTIVE , FAILED , CANCELLED , EXPIRED )
[]
Example: ``
updated_at_max string
[]
Subscription contract update time ( end ) ( format see IOS8601 )
updated_at_min string
[]
Subscription contract update time ( start ) ( format see IOS8601 )
user_ids array
[]
User id list , up to 50
[]
Example: ``

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

page_infoobject
[]
Paging information
end_cursor string
[]
1
has_next_page boolean
[]
1
has_previous_page boolean
[]
1
start_cursor string
[]
1
subscription_contractsobject[]
[]
Subscription contract information list
appobject
[]
Subscription plug-in information
app_key string
[]
Key for app insert
billing_policyobject
[]
Billing policy for the subscription agreement
interval string
[]
Interval units , ( day , MONTH , weed , year )
interval_count integer
[]
Interval value
max_cycles integer
[]
Largest subscription cycle
min_cycles integer
[]
Minimum subscription cycle
created_at string
[]
Creation time
currency_code string
[]
Currency
customerobject
[]
User information
email string
[]
User mailbox
id string
[]
User ID
nick_name string
[]
User name
phone string
[]
User phone
shipping_addressobject
[]
Shipping address
address1 string
[]
Consignee detailed address
address2 string
[]
Consignee additional to the detailed address
city string
[]
Consignee city
city_code string
[]
Consignee city code
company string
[]
Company name
country string
[]
Country or region
country_code string
[]
Country or region , please refer to the country code specification biography , https : //aurogon-portal.yy.com/document/interface/478
district string
[]
Consignee zone
district_code string
[]
Consignee zone code
first_name string
[]
Consignee name
last_name string
[]
Consignee last name
phone string
[]
Consignee contact
province string
[]
Consignee province
province_code string
[]
Consignee province code
zip string
[]
Postal code
customer_payment_methodobject
[]
payment method
channel_code string
[]
Payment channel encoding
instrument_detailobject
[]
Payment tool details
cardobject
[]
Card information
brand string
[]
Card brand
brand_icon string
[]
Card icon
expire_month string
[]
Expiration date : month
expire_year string
[]
Expiration date : year
first string
[]
Card number front display bit
holder string
[]
Card holder name
last string
[]
Card number rear display bit
type string
[]
Type card / account. card : carnegie ; account : account base
instrument_seq string
[]
Payment tool id
method_code string
[]
Payment method encoding
store_payment_id string
[]
Payment method id
delivery_infoobject
[]
Shipping information
delivery_name string
[]
Scheme name
delivery_seq string
[]
The seq for the shipping program
id string
[]
Contract id
last_payment_status string
[]
Last payment status
line_itemsobject[]
[]
Contract associated Product
amount string
[]
Product amount ( two precision string , like " 88.10 " )
amount_setobject
[]
Product amount
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
currency_code string
[]
Currency
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
currency_code string
[]
Currency
attributesobject[]
[]
Product attributes
key string
[]
Attributes key or name
value string
[]
Attribute value
group_id string
[]
Item group id
image_url string
[]
Product main image
pricing_policyobject[]
[]
Subscription cycle discount
cycle_discountsobject[]
[]
Adjust per cycle of the subscribe to the line
adjustment_type string
[]
Discount type , FIXED_AMOUNT : minus , PERCENTAGE : discount ( minus percentage )
adjustment_value long
[]
Discount value subtraction amount ( points ) or ratio
product_source string
[]
Product source main_site main station product、customize custom product
quantity integer
[]
Product quantity
sku string
[]
Product yards
title string
[]
Product title
variant_attribute string
[]
Product attributes
variant_id string
[]
Product SKU serial number
version string
[]
Product version
next_billing_date string
[]
Next bill date
origin_orderobject
[]
Original order information
id string
[]
Order number
periods integer
[]
Duration of current contract execution
status string
[]
Subscription contract status ( ACTIVE , FAILED , CANCELLED , EXPIRED )
updated_at string
[]
Update time

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Body

Body required

{
  "after": "",
  "before": "",
  "created_at_max": "",
  "created_at_min": "",
  "first": 0,
  "ids": [
    ""
  ],
  "last": 0,
  "next_billing_date_at_max": "",
  "next_billing_date_at_min": "",
  "reverse": false,
  "status": [
    ""
  ],
  "updated_at_max": "",
  "updated_at_min": "",
  "user_ids": [
    ""
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/subscription/contract.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal