Get all available information about a subscription referring to its ID.
📘
To get the information about subscription use secret token. The read_subscriptions access scope is required. Reach out to us at [email protected] to add the scope.
Headers
Name
Type
Description
Authorization
string
oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.
Response
A JSON object of type 'Subscription' with the following fields:
Subscription
Field
Type
Description
subscriptionId
number
Subscription ID (e.g. 66528).
customerId
number
Customer ID (e.g. 153974305).
status
string
Subscription status. One of: ACTIVE, CANCELLED, LAST_CHARGE_FAILED or REQUIRES_PAYMENT_CONFIRMATION.
statusUpdated
string
Subscription status update date and time. E.g. 2021-07-23 21:17:26 +0000.
created
string
Subscription creation date and time. E.g 2021-05-26 13:37:46 +0000.
cancelled
string
Subscription cancellation date and time. E.g. 2021-06-03 22:11:39 +0000.
nextCharge
string
Subscription's next charge date and time. E.g. 2021-07-16 12:53:40 +0000.
createTimestamp
number
Date of subscription creation in UNIX Timestamp format. E.g. 1623848020508.
updateTimestamp
number
Date of subscription update in UNIX Timestamp format. E.g. 1627075046478.
Charge recurring interval. Supported values: for DAY - 1 (daily), for WEEK - 1 (weekly), 2 (biweekly), for MONTH - 1 (monthly), 3 (quarterly), for YEAR - 1 (annually).
subscriptionPriceWithSignUpFee
number
The cost of the product for the first subscription order.
signUpFee
number
The size of the markup that is imposed on the first order.
PaymentMethod
Field
Type
Description
creditCardMaskedNumber
string
Credit card masked number, e.g. *1111.
creditCardBrand
string
Credit card brand, e.g. Visa.
OrderTemplate
Field
Type
Description
id
string
Subscription order ID
email
string
Subscription's customer email.
additionalInfo
<AdditionalInfo>
Additional order information.
orderComments
string
Order comments.
paymentMethod
string
Payment method name, e.g. "Credit or debit card".
paymentModule
string
Payment provider name, e.g. "Stripe".
total
number
Subscription order total.
subtotal
number
Subscription order subtotal.
usdTotal
number
Subscription order total in USD.
tax
number
Tax total.
customerTaxExempt
boolean
true if customer is tax exempt, false otherwise. Learn more.
customerTaxId
string
Tax ID of a customer.
customerTaxIdValid
boolean
true if customer tax ID is valid, false otherwise.
reversedTaxApplied
boolean
true if order tax was set to 0 because customer specified their valid tax ID in checkout process. false otherwise.
items
Array<OrderItems>
Order items information.
billingPerson
<PersonInfo>
Billing person information.
shippingPerson
<PersonInfo>
Shipping person information.
shippingOption
<ShippingOption>
Shipping option information.
handlingFee
<HandlingFee>
Handling fee details.
pricesIncludeTax
boolean
true if the tax rate is included in order price, false otherwise. Learn more.
AdditionalInfo
Field
Type
Description
creditCard
string
Masked credit card digitals and expiration date, e.g. *1111 (12/2024).
creditCardExpirationMonth
string
Credit card expiration month, e.g. 12.
creditCardExpirationYear
string
Credit card expiration year, e.g. 24.
google_customer_id
string
Google customer ID. E.g. 11111111.2222222222.
stripeCardId
string
Stripe card ID. E.g. pm_1X2xXXX34XXxXxxXxxxXXXX.
stripeCreditCardBrand
string
Stripe credit card brand, e.g. Visa.
stripeCreditCardLast4Digit
string
Stripe credit card last 4 digits, e.g. 1111.
stripeCustomerId
string
Stripe customer ID, e.g. cus_XXXxxxX12xxxxX.
stripeFingerprint
string
Stripe fingerpring, e.g. xxxxxXXX1X2xxxXX.
stripeLiveMode
boolean
true if Stripe account is in live mode, false otherwise.
OrderItems
Field
Type
Description
id
number
Order item ID. Can be used to address the item in the order, e.g. to manage ordered items.
productId
number
Store product ID.
categoryId
number
ID of the category this product belongs to. If the product belongs to many categories, categoryID will return the ID of the default product category. If the product doesn't belong to any category, 0 is returned.
price
number
Price of ordered item in the cart
productPrice
number
Basic product price without options markups, wholesale discounts etc.
shipping
number
Order item shipping cost.
tax
number
Tax amount applied to the item.
fixedShippingRate
number
Fixed shipping rate for the product.
sku
string
Product SKU. If the chosen options match a variation, this will be a variation SKU.
name
string
Product name.
shortDescription
string
Product description truncated to 120 characters.
quantity
number
Amount purchased.
quantityInStock
number
The number of products in stock in the store.
weight
number
Product weight.
trackQuantity
boolean
true/false: shows whether the store admin set to track the quantity of this product and get low stock notifications.
fixedShippingRateOnly
boolean
true/false: shows whether the fixed shipping rate is set for the product.
digital
boolean
true/false: shows whether the item has downloadable files attached.
productAvailable
boolean
true if product is available (enabled), false otherwise.
Charge recurring interval. Supported values: for DAY - 1 (daily), for WEEK - 1 (weekly), 2 (biweekly), for MONTH - 1 (monthly), 3 (quarterly), for YEAR - 1 (annually).
SelectedOptions
Field
Type
Description
name
string
Product option name, e.g. Color.
type
string
One of SELECT, RADIO, CHECKBOX, TEXTFIELD, TEXTAREA, DATE, FILES, SIZE.
value
string
Selected product option value, e.g. White.
valuesArray
Array
Array of product options values.
selections
Array<Selections>
Product option selections details.
Selections
Field
Type
Description
selectionTitle
string
Selected product option title, e.g. White.
selectionModifier
number
Percent or absolute value of the option's price markup. Positive, negative and zero values are allowed. Default is 0.
selectionModifierType
string
Option markup calculation type. PERCENT or ABSOLUTE. Default is ABSOLUTE.
Taxes
Field
Type
Description
name
string
Tax name.
value
number
Tax value, e.g. 22.
total
number
Tax total, e.g. 4.84.
taxOnDiscountedSubtotal
number
Tax on item subtotal (after applying discounts).
taxOnShipping
number
Tax on item shipping.
includeInPrice
boolean
true if the tax rate is included in product prices. More details: Taxes in Ecwid.
Dimensions
Field
Type
Description
length
number
Length of a product.
width
number
Width of a product.
height
number
Height of a product.
PersonInfo
Field
Type
Description
name
string
Full name
companyName
string
Company name
street
string
Address line 1 and address line 2, separated by '\n'
city
string
City
countryCode
string
Two-letter country code
countryName
string
Country name
postalCode
string
Postal/ZIP code
stateOrProvinceCode
string
State code, e.g. NY
stateOrProvinceName
string
State/province name, e.g. New York
phone
string
Phone number
ShippingOption
Field
Type
Description
shippingMethodName
string
Optional. Is present for orders made with carriers, e.g. USPS or shipping applications.
shippingRate
number
Rate
HandlingFee
Field
Type
Description
name
string
Handling fee name set by store admin. E.g. Wrapping
value
number
Handling fee value
description
string
Handling fee description for customer
Orders
Field
Type
Description
id
number
Internal order number.
total
number
Order total.
createDate
string
Order creation date and time, e.g. 2021-06-16 12:53:39 +0000.
