Query subscription contract details

Requires read_subscription_contracts access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20261201/subscription/:id/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 .

query a subscription contract

Path Parameters

id string required

Contract single number

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

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

subscription_contractobject

Subscription contract information details
customerobject

User information
id string

User id , buyerId
nick_name string

User nickname
phone string

User phone
shipping_addressobject

Shipping address
province_code string

Consignee province code
phone string

Consignee contact
province string

Consignee province
city string

Consignee city
city_code string

Consignee city code
first_name string

Consignee name
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
zip string

Postal code
country string

Country or region
last_name string

Consignee last name
district_code string

Consignee zone code
address2 string

Consignee additional to the detailed address
company string

Company name
address1 string

Consignee detailed address
email string

User mail
created_at string

Created time , 2019-09-07T15 : 50 : 00 z
updated_at string

Update time , 2019-09-07T15 : 50 : 00 z
delivery_infoobject

Shipping information
delivery_name string

Scheme name
delivery_seq string

The seq for the shipping program
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
origin_orderobject

Original order information
id string

Order number
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 number 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
accountobject

Account information
name string

Account name
id string

Contract single number
last_payment_status string

Last payment status
next_billing_date string

Next bill date
currency_code string

Store currency
periods integer

Duration of current contract execution
status string

Subscription contract status
line_itemsobject[]

Associated Product
amount_setobject

Product amount , multi-currency format
presentment_moneyobject

presentment money
amount string

Amount
currency_code string

Currency
shop_moneyobject

shop money
amount string

Amount
currency_code string

Currency
variant_id string

Product SKU serial number
group_id string

Item group id
quantity integer

Product quantity
version string

Product version
amount string

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

Product source main_site main station product、customize custom product
sku string

Item no .
title string

Product title
attributesobject[]

Product attributes : name , attribute value
key string

Attributes key or name
value string

Attribute value
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
variant_attribute string

Product attributes
appobject

Subscription plug-in information
app_key string

Key for app insert

API Explorer

Debugger

Base URL

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

ParamOptions

id — path required

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/subscription/id/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