Query subscription contract list

Requires read_subscription_contracts access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/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 string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

next_billing_date_at_min string

Subscribe to next bill generation time ( start ) ( format see IOS8601 )
updated_at_max string

Subscription contract update time ( end ) ( format see IOS8601 )
created_at_min string

Subscription contract production time ( start ) ( format see IOS8601 )
reverse boolean

Sort inversion
updated_at_min string

Subscription contract update time ( start ) ( format see IOS8601 )
user_ids array

User id list , up to 50
Example: [""]
first integer

The front n elements of return support up to 50 , and the last must and only one cannot be empty
created_at_max string

Subscription contract production time ( end ) ( format see IOS8601 )
ids array

Contract id list
Example: [""]
next_billing_date_at_max string

Subscribe to next bill-generation time ( end ) ( format see IOS8601 )
status array

Subscription contract status ( ACTIVE , FAILED , CANCELLED , EXPIRED )
Example: [""]
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 .
last integer

Return last n elements , maximum support 50 , must be with first and only one cannot be empty

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

page_infoobject

Paging information
has_next_page boolean

1
has_previous_page boolean

1
start_cursor string

1
end_cursor string

1
subscription_contractsobject[]

Subscription contract information list
line_itemsobject[]

Contract associated Product
title string

Product title
amount string

Product amount ( two precision string , like " 88.10 " )
group_id string

Item group id
image_url string

Product main image
sku string

Product yards
variant_attribute string

Product attributes
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
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
variant_id string

Product SKU serial number
version string

Product version
product_source string

Product source main_site main station product、customize custom product
attributesobject[]

Product attributes
key string

Attributes key or name
value string

Attribute value
quantity integer

Product quantity
id string

Contract id
last_payment_status string

Last payment status
next_billing_date string

Next bill date
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
customer_payment_methodobject

payment method
instrument_seq string

Payment tool id
method_code string

Payment method encoding
store_payment_id string

Payment method id
channel_code string

Payment channel encoding
instrument_detailobject

Payment tool details
cardobject

Card information
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
brand string

Card brand
type string

Type card / account. card : carnegie ; account : account base
updated_at string

Update time
customerobject

User information
shipping_addressobject

Shipping address
company string

Company name
first_name string

Consignee name
city_code string

Consignee city code
province string

Consignee province
country_code string

Country or region , please refer to the country code specification biography , https : //aurogon-portal.yy.com/document/interface/478
city string

Consignee city
country string

Country or region
province_code string

Consignee province code
district_code string

Consignee zone code
last_name string

Consignee last name
zip string

Postal code
district string

Consignee zone
phone string

Consignee contact
address1 string

Consignee detailed address
address2 string

Consignee additional to the detailed address
email string

User mailbox
id string

User ID
nick_name string

User name
phone string

User phone
appobject

Subscription plug-in information
app_key string

Key for app insert
created_at string

Creation time
periods integer

Duration of current contract execution
status string

Subscription contract status ( ACTIVE , FAILED , CANCELLED , EXPIRED )
origin_orderobject

Original order information
id string

Order number
currency_code string

Currency
delivery_infoobject

Shipping information
delivery_name string

Scheme name
delivery_seq string

The seq for the shipping program

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

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

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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