Get subscription

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

NameTypeDescription
AuthorizationstringoAuth 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

FieldTypeDescription
subscriptionIdnumberSubscription ID (e.g. 66528).
customerIdnumberCustomer ID (e.g. 153974305).
statusstringSubscription status. One of: ACTIVE, CANCELLED, LAST_CHARGE_FAILED or REQUIRES_PAYMENT_CONFIRMATION.
statusUpdatedstringSubscription status update date and time. E.g. 2021-07-23 21:17:26 +0000.
createdstringSubscription creation date and time. E.g 2021-05-26 13:37:46 +0000.
cancelledstringSubscription cancellation date and time. E.g. 2021-06-03 22:11:39 +0000.
nextChargestringSubscription's next charge date and time. E.g. 2021-07-16 12:53:40 +0000.
createTimestampnumberDate of subscription creation in UNIX Timestamp format. E.g. 1623848020508.
updateTimestampnumberDate of subscription update in UNIX Timestamp format. E.g. 1627075046478.
chargeSettings<ChargeSettings>Charge settings information.
paymentMethod<PaymentMethod>Payment method information.
orderTemplate<OrderTemplate>Subscription order information.
ordersArray<Orders>Orders details.

ChargeSettings

FieldTypeDescription
recurringIntervalstringCharge recurring interval. Supported values: DAY, WEEK, MONTH, YEAR.
recurringIntervalCountnumberCharge recurring interval. Supported values: for DAY - 1 (daily), for WEEK - 1 (weekly), 2 (biweekly), for MONTH - 1 (monthly), 3 (quarterly), for YEAR - 1 (annually).
subscriptionPriceWithSignUpFeenumberThe cost of the product for the first subscription order.
signUpFeenumberThe size of the markup that is imposed on the first order.

PaymentMethod

FieldTypeDescription
creditCardMaskedNumberstringCredit card masked number, e.g. *1111.
creditCardBrandstringCredit card brand, e.g. Visa.

OrderTemplate

FieldTypeDescription
idstringSubscription order ID
emailstringSubscription's customer email.
additionalInfo<AdditionalInfo>Additional order information.
orderCommentsstringOrder comments.
paymentMethodstringPayment method name, e.g. "Credit or debit card".
paymentModulestringPayment provider name, e.g. "Stripe".
totalnumberSubscription order total.
subtotalnumberSubscription order subtotal.
usdTotalnumberSubscription order total in USD.
taxnumberTax total.
customerTaxExemptbooleantrue if customer is tax exempt, false otherwise. Learn more.
customerTaxIdstringTax ID of a customer.
customerTaxIdValidbooleantrue if customer tax ID is valid, false otherwise.
reversedTaxAppliedbooleantrue if order tax was set to 0 because customer specified their valid tax ID in checkout process. false otherwise.
itemsArray<OrderItems>Order items information.
billingPerson<PersonInfo>Billing person information.
shippingPerson<PersonInfo>Shipping person information.
shippingOption<ShippingOption>Shipping option information.
handlingFee<HandlingFee>Handling fee details.
pricesIncludeTaxbooleantrue if the tax rate is included in order price, false otherwise. Learn more.

AdditionalInfo

FieldTypeDescription
creditCardstringMasked credit card digitals and expiration date, e.g. *1111 (12/2024).
creditCardExpirationMonthstringCredit card expiration month, e.g. 12.
creditCardExpirationYearstringCredit card expiration year, e.g. 24.
google_customer_idstringGoogle customer ID. E.g. 11111111.2222222222.
stripeCardIdstringStripe card ID. E.g. pm_1X2xXXX34XXxXxxXxxxXXXX.
stripeCreditCardBrandstringStripe credit card brand, e.g. Visa.
stripeCreditCardLast4DigitstringStripe credit card last 4 digits, e.g. 1111.
stripeCustomerIdstringStripe customer ID, e.g. cus_XXXxxxX12xxxxX.
stripeFingerprintstringStripe fingerpring, e.g. xxxxxXXX1X2xxxXX.
stripeLiveModebooleantrue if Stripe account is in live mode, false otherwise.

OrderItems

FieldTypeDescription
idnumberOrder item ID. Can be used to address the item in the order, e.g. to manage ordered items.
productIdnumberStore product ID.
categoryIdnumberID 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.
pricenumberPrice of ordered item in the cart
productPricenumberBasic product price without options markups, wholesale discounts etc.
shippingnumberOrder item shipping cost.
taxnumberTax amount applied to the item.
fixedShippingRatenumberFixed shipping rate for the product.
skustringProduct SKU. If the chosen options match a variation, this will be a variation SKU.
namestringProduct name.
shortDescriptionstringProduct description truncated to 120 characters.
quantitynumberAmount purchased.
quantityInStocknumberThe number of products in stock in the store.
weightnumberProduct weight.
trackQuantitybooleantrue/false: shows whether the store admin set to track the quantity of this product and get low stock notifications.
fixedShippingRateOnlybooleantrue/false: shows whether the fixed shipping rate is set for the product.
digitalbooleantrue/false: shows whether the item has downloadable files attached.
productAvailablebooleantrue if product is available (enabled), false otherwise.
imageUrlstringProduct image URL.
recurringChargeSettings<RecurringChargeSettings>Recurring charge settings.
selectedOptionsArray<SelectedOptions>Selected product options information.
taxesArray<Taxes>Taxes information.
dimensions<Dimensions>Dimensions details.

RecurringChargeSettings

FieldTypeDescription
recurringIntervalstringCharge recurring interval. Supported values: DAY, WEEK, MONTH, YEAR.
intervalCountnumberCharge 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

FieldTypeDescription
namestringProduct option name, e.g. Color.
typestringOne of SELECT, RADIO, CHECKBOX, TEXTFIELD, TEXTAREA, DATE, FILES, SIZE.
valuestringSelected product option value, e.g. White.
valuesArrayArrayArray of product options values.
selectionsArray<Selections>Product option selections details.

Selections

FieldTypeDescription
selectionTitlestringSelected product option title, e.g. White.
selectionModifiernumberPercent or absolute value of the option's price markup. Positive, negative and zero values are allowed. Default is 0.
selectionModifierTypestringOption markup calculation type. PERCENT or ABSOLUTE. Default is ABSOLUTE.

Taxes

FieldTypeDescription
namestringTax name.
valuenumberTax value, e.g. 22.
totalnumberTax total, e.g. 4.84.
taxOnDiscountedSubtotalnumberTax on item subtotal (after applying discounts).
taxOnShippingnumberTax on item shipping.
includeInPricebooleantrue if the tax rate is included in product prices. More details: Taxes in Ecwid.

Dimensions

FieldTypeDescription
lengthnumberLength of a product.
widthnumberWidth of a product.
heightnumberHeight of a product.

PersonInfo

FieldTypeDescription
namestringFull name
companyNamestringCompany name
streetstringAddress line 1 and address line 2, separated by '\n'
citystringCity
countryCodestringTwo-letter country code
countryNamestringCountry name
postalCodestringPostal/ZIP code
stateOrProvinceCodestringState code, e.g. NY
stateOrProvinceNamestringState/province name, e.g. New York
phonestringPhone number

ShippingOption

FieldTypeDescription
shippingMethodNamestringOptional. Is present for orders made with carriers, e.g. USPS or shipping applications.
shippingRatenumberRate

HandlingFee

FieldTypeDescription
namestringHandling fee name set by store admin. E.g. Wrapping
valuenumberHandling fee value
descriptionstringHandling fee description for customer

Orders

FieldTypeDescription
idnumberInternal order number.
totalnumberOrder total.
createDatestringOrder creation date and time, e.g. 2021-06-16 12:53:39 +0000.
Language
Authentication
Query