Query the effective plan of the store

Requires read_store_metrics access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/store/subscription

[]

Query the current effective package of the store (including the current period and the next period)

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

include_trial boolean
[]
Package of trial period or not included . default true

Response

[]

Response Headers

traceId
[]
traceId

Response Body

code string
[]
Response code
[]
Example: SUCCESS
dataobject[]
[]
Response data
auto_recurring boolean
[]
To open automatic renewal or not
[]
Example: true
billing_cycle string
[]
Package cycle
[]
Example: monthly
cancelled_at long
[]
Cancel time
[]
Example: 1689504361000
created_at long
[]
Creation time
[]
Example: 1689504361000
enable boolean
[]
Effective or not
[]
Example: true
end_at long
[]
End time
[]
Example: 1692182769000
extend_peroid integer
[]
Long when giving away ( unit second )
grace_period integer
[]
Package grace ( unit seconds )
grace_period_end_at long
[]
Package grace end time
[]
Example: 1692182769000
merchant_email string
[]
Merchant mailbox
[]
Example: laokunfang@shoplineapp.com
merchant_id long
[]
Merchant id
[]
Example: 4200320559
next_recurring_at long
[]
Next time automatic re-charge
[]
Example: 1692182769000
payment_method string
[]
payment method
[]
Example: CreditCard
product_line string
[]
Package version key
[]
Example: cn_monthly_standard
product_name map
[]
Package version name
[]
Example: [object Object]
remarks string
[]
Instructions
start_at long
[]
Start time
[]
Example: 1689504369000
status string
[]
Package status
[]
Example: active
store_handle string
[]
Store handle
[]
Example: laokunfang18
store_id long
[]
Store id
[]
Example: 1666942294702
sub_id string
[]
Package id
[]
Example: SUB6025977562148654205
type string
[]
Package type
[]
Example: paid
message string
[]
Response information
[]
Example: success
success string
[]
Succeed or not?
[]
Example: true

API Explorer

Debugger

Base URL

https://{handle}.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Body

Body required

{
  "include_trial": false
}

Language

curl --request GET \
     --url https://handle.myshopline.com/admin/openapi/v20250601/store/subscription \
     --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