Read customer details by Shopify ID

POST https://api.loopsubscriptions.com/api/external/v1/customers/read-by-shopify-id

Rate limit: 10/ sec

Customer object description

Field	Description
customer_shopify_id	Shopify id of the customer.
first_name	First name of the customer.
last_name	Last name of the customer.
next_billing_date	The upcoming date when the customer will be billed
active_subscriptions	The count of all the active subscriptions of the customer
paused_subscriptions	The count of all the paused subscriptions of the customer
cancelled_subscriptions	The count of all the cancelled subscriptions of the customer
subscriptions	An array containing all the subscriptions of the customer. See the Subscriptions object for more details

Subscription Object Description

Field	Description
subscription_shopify_id	Shopify id of the subscription contract.
status	Status of the subscription as on Shopify.
created_at	Date time when the subscription was created.
updated_at	Date time when the subscription was last updated.
paused_at	Date time when the subscription was paused.
cancelled_at	Date time when the subscription was cancelled.
cancellation_reason	Reason selected by the customer for cancelling subscription.
is_prepaid	Boolean value specifying if the subscription is prepaid or not.
next_billing_date	Date time of the next upcoming charge for the subscription.
charge_offset_days	Useful for scheduling orders based on delivery dates. Delivery date = next_billing_date + charge_offset_days.
last_payment	Whether the last payment was a success or failure
payment_failure_reason	The reason for payment failure if last payment failed
completed_orders_to_date	Number of successful billing attempts or in other words the total number of orders created for a subscription including the first order.
total_line_item_price	Total price of all the subscription line items not including taxes & discounts.
total_line_item_discounted_price	Total price of all the subscription line items including discounts.
currency	Currency code for all the prices.
shipping_price	Shipping charges associated with the delivery.
shipping_price_currency_code	Currency code for the shipping price
billing_interval_count	Billing interval
delivery_interval_count	Delivery interval
line_items	An array of line items associated with the contract. See Line Items object for more details

Line Items Object Description

Field	Description
name	The name of the product variant
product_shopify_id	The shopify id of the product
variant_shopify_id	The shopify id of the variant
quantity	Quantity for the product variant associated with the line.
subscription_price	Subscription price for the product variant associated with the line.
base_price	Base price for the product variant associated with the line. Subscription discounts are applied on this price.
discounted_price	Final discounted price for the product variant charged to the customer after applying discounts.
is_one_time_added	Specifies whether the product is added only for the upcoming order or not.
is_one_time_removed	Specifies whether the product is removed only for the upcoming order or not.
created_at	Date time when the subscription was created.
updated_at	Date time when the subscription was updated.

❗️

These docs are for a deprecated API version. Visit here to refer the latest API docs.