Query subscription contract list

Requires read_subscription_contracts access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20261201/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 eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Request Body

updated_at_max string

Subscription contract update time ( end ) ( format see IOS8601 )
reverse boolean

Sort inversion
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
ids array

Contract id list
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 .
created_at_min string

Subscription contract production time ( start ) ( format see IOS8601 )
updated_at_min string

Subscription contract update time ( start ) ( format see IOS8601 )
created_at_max string

Subscription contract production time ( end ) ( format see IOS8601 )
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: [""]
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
next_billing_date_at_min string

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

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
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
title string

Product title
amount string

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

Product main image
amount_setobject

Product amount
presentment_moneyobject

Currency information
amount string

Amount
currency_code string

Currency
shop_moneyobject

Sell side amount
currency_code string

Currency
amount string

Amount
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
quantity integer

Product quantity
group_id string

Item group id
sku string

Product yards
variant_attribute string

Product attributes
customerobject

User information
shipping_addressobject

Shipping address
first_name string

Consignee name
province string

Consignee province
zip string

Postal code
company string

Company name
city_code string

Consignee city code
country_code string

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

Country or region
last_name string

Consignee last name
phone string

Consignee contact
address2 string

Consignee additional to the detailed address
city string

Consignee city
district_code string

Consignee zone code
address1 string

Consignee detailed address
province_code string

Consignee province code
district string

Consignee zone
email string

User mailbox
id string

User ID
nick_name string

User name
phone string

User phone
next_billing_date string

Next bill date
billing_policyobject

Billing policy for the subscription agreement
max_cycles integer

Largest subscription cycle
min_cycles integer

Minimum subscription cycle
interval string

Interval units , ( day , MONTH , weed , year )
interval_count integer

Interval value
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
holder string

Card holder name
last string

Card number rear display bit
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
type string

Type card / account. card : carnegie ; account : account base
appobject

Subscription plug-in information
app_key string

Key for app insert
created_at string

Creation time
status string

Subscription contract status ( ACTIVE , FAILED , CANCELLED , EXPIRED )
id string

Contract id
last_payment_status string

Last payment status
periods integer

Duration of current contract execution
origin_orderobject

Original order information
id string

Order number
updated_at string

Update time
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/v20261201

ParamOptions

Authorization — header required

Body

Body required

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

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/subscription/contract.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal