Get Customer
Get a specific customer
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The name of the store to perform actions on via the API
ID or email associated with the customer
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The name of the store to perform actions on via the API
Path Parameters
ID or email associated with the customer
Response
Customer ID
The shop ID to which this customer belongs
Customer email
Customer name
Customer surname
Customer phone
Customer phone country code
Customer country code
Customer street address
Customer street address additional info
Customer city
Customer postal code
Customer state
Revenue customer has recieved from the affiliate program
The currency the customer gets reimbursed in for the affiliate program
Timestamp for the creation of the customer
ID of the legacy subscription
ID of product subscription for subscriptions 2.0
The shop ID to which this subscription belongs
ID of the product subscription
ID of the subscriptions 2.0 active product plan
ID of the store's customer
The subscription version
v1, v2 Timestamp for the creation of the subscription
When this subscription was last updated
Subscription status
PENDING, CANCELED, TRIALING, ACTIVE Gateway chosen for this subscription. A new invoice monthly will be created using this gayeway
PAYPAL, STRIPE, SKRILL, PERFECT_MONEY, CASH_APP, BINANCE, BITCOIN, LITECOIN, ETHEREUM, BITCOIN_CASH, NANO, MONERO, SOLANA, RIPPLE, BINANCE_COIN, USDC, USDT, TRON, BITCOIN_LN, CONCORDIUM, POLYGON, PEPE, DAI, WETH, APE, SHIB, USDC_NATIVE, DOGECOIN, PYTH, BONK, JUP, JITO, WEN, RENDER, MOBILE, HNT Origin of the subscription
STOREFRONT, PAYMENT_LINK, CHECKOUT The custom fields passed by the user at checkout. The type is map<string, string>
If a coupon has been applied, its ID
When the current billing period will end
Whether or not the email for an upcoming renewal has been sent
Whether or not the email for the trial period expiring has been sent
If true, the renewal invoice has already been created
The ID of the payment link used to pay the initial payment for this subscription
Details about the subscription status
PAYMENT_FAILED, CART_PARTIAL_OUT_OF_STOCK When this subscription was canceled
ID of the customer created on STRIPE
ID of the Stripe connected account
ID of the Stripe subscription
The ID of the PayPal account used to complete the subscription payments
The ID of the PayPal subscription
Digital Software
The title of the product plan for this subscription (only for type: v2)
The cloudflare image ID of this product, replaces image_attachment and image_name. Format https://imagedelivery.net/95QNzrEeP7RU5l5WdbyrKw/<cloudflare_image_id>/<variant_name> where variant_name can be shopItem, avatar, icon, imageAvatarFeedback, public, productImageCart
Customer name
Customer surname
Customer phone
Customer phone country code
Customer country code
Customer street address
Customer street address additional info
Customer city
Customer postal code
Customer state
Customer email
Internal ID of the resource
Unique ID of the resource, used as reference across the API
Unique ID of the recurring bill
The timestamp for when the billing for the invoice started
The timestamp for when the billing for the invoice ended
Invoice type. For subscriptions, the invoice type is PRODUCT_SUBSCRIPTION as SUBSCRIPTION is reserved for Sellix-own plans
PRODUCT, SUBSCRIPTION, PUBLIC_REST_API, MONTHLY_BILL, SHOPPING_CART, PRODUCT_SUBSCRIPTION Product type
INFO_CARD, SERVICE, DYNAMIC, FILE, SERIALS, GAMING_RCON, SUBSCRIPTION, SUBSCRIPTION_V2 How the invoice was created
STOREFRONT, API, EMBED The shop ID to which this invoice belongs
The ID of the wallet platform used during checkout
ID of the customer
Unique ID of the product linked to this invoice, if any
The id of the product the plan belongs to
ID of the customer who is affiliated to the purchase
Internal ID of the resource
Unique id of the resouce. The id for external usage through the API
The shop ID to which this addon belongs
The product types for the product addon
The title of the product addon
The description of the product addon
The price of the product addon
Available currency
CAD, HKD, ISK, PHP, DKK, HUF, CZK, GBP, RON, SEK, IDR, INR, BRL, RUB, HRK, JPY, THB, CHF, EUR, MYR, BGN, TRY, CNY, NOK, NZD, ZAR, USD, MXN, SGD, AUD, ILS, KRW, PLN Product type
INFO_CARD, SERVICE, DYNAMIC, FILE, SERIALS, GAMING_RCON, SUBSCRIPTION, SUBSCRIPTION_V2 Product title
Field reserved for Sellix-own plans. Unique ID of the subscription purchased
Field reserved for Sellix-own plans. Time, in seconds, of the subscription purchased
Gateway chosen for this invoice. If null, the customer will be asked for a gateway in the Sellix hosted invoice page
PAYPAL, STRIPE, SKRILL, PERFECT_MONEY, CASH_APP, BINANCE, BITCOIN, LITECOIN, ETHEREUM, BITCOIN_CASH, NANO, MONERO, SOLANA, RIPPLE, BINANCE_COIN, USDC, USDT, TRON, BITCOIN_LN, CONCORDIUM, POLYGON, PEPE, DAI, WETH, APE, SHIB, USDC_NATIVE, DOGECOIN, PYTH, BONK, JUP, JITO, WEN, RENDER, MOBILE, HNT The blockchain of the crypto currency
ERC20, BEP20, TRC20, MATIC, SOL PAYPAL, STRIPE, SKRILL, PERFECT_MONEY, CASH_APP, BINANCE, BITCOIN, LITECOIN, ETHEREUM, BITCOIN_CASH, NANO, MONERO, SOLANA, RIPPLE, BINANCE_COIN, USDC, USDT, TRON, BITCOIN_LN, CONCORDIUM, POLYGON, PEPE, DAI, WETH, APE, SHIB, USDC_NATIVE, DOGECOIN, PYTH, BONK, JUP, JITO, WEN, RENDER, MOBILE, HNT PayPal Alternative Payment Method name, such as iDEAL, used if gateway is PAYPAL
Stripe Alternative Payment Method name, such as iDEAL, used if gateway is STRIPE
afterpay_clearpay, alipay, bancontact, au_becs_debit, boleto, eps, fpx, giropay, grabpay, ideal, klarna, oxxo, p24, sofort, wechat_pay Qauntity of product purchased
Invoice total, unit_price*quantity where quantity is applicable
Invoice total in the currency chosen
The percentage of tax applied on the transaction
Unique ID of the coupon, if used, for the discount
If a coupon or volume_discount is used, the discount value presents the total amount of discount over the total cost of the invoice
If a coupon or volume_discount is used, the displayed discount value presents the total amount of discount over the total cost of the invoice
Representation of how discount was applied to invoice
Internal ID of the resource
Unique ID of the bundle, used as reference across the API
The shop ID to which this bundle belongs
The title of the bundle
The product IDs of the products in the bundle
The type of discount applied to the bundle
PERCENTAGE, FIXED The amount of the discount applied to the bundle
Timestamp, available if the bundle has been updated
The discount value applied from a volume_discount
The diplayed discount value applied from a volume_discount
Available currency
CAD, HKD, ISK, PHP, DKK, HUF, CZK, GBP, RON, SEK, IDR, INR, BRL, RUB, HRK, JPY, THB, CHF, EUR, MYR, BGN, TRY, CNY, NOK, NZD, ZAR, USD, MXN, SGD, AUD, ILS, KRW, PLN Exchange rate between currency chosen and USD
Exchange rate between the cryptocurrency chosen (if any) and USD
Email of the customer
The oauth access token provided by discord during checkout
The oauth refresh token provided by discord during checkout
Timstamp for the expiration of the discord oauth tokens
If true and gateway is PAYPAL, the product will be shipped to the PayPal email on record instead of the customer email
Merchant PayPal email
This field contains the PayPal order ID
This field contains the PayPal authorization ID
This field contains the PayPal capture ID
This field is updated after the invoice is completed with the PayPal's email used for the purchase
This field is updated after the invoice is completed with the fee taken by PayPal over the invoice total
Available currency
CAD, HKD, ISK, PHP, DKK, HUF, CZK, GBP, RON, SEK, IDR, INR, BRL, RUB, HRK, JPY, THB, CHF, EUR, MYR, BGN, TRY, CNY, NOK, NZD, ZAR, USD, MXN, SGD, AUD, ILS, KRW, PLN This field contains the API version of PayPal that is used
ID of the paypal subscription
Link for the merchant to purchase the subscription from
DEPRECATED
DEPRECATED
DEPRECATED
DEPRECATED
DEPRECATED
DEPRECATED
Merchant Skrill email
Skrill unique ID linked to the invoice
Skrill link to redirect the customer to
Client ID used to create the STRIPE paymentIntent
Client secret used to create the STRIPE paymentIntent
If the invoice type is PRODUCT_SUBSCRIPTION or SUBSCRIPTION, refers to the STRIPE price ID
The ID of the stripe customer the invoice is for
If the invoice type is SUBSCRIPTION, refers to the STRIPE subscription ID
If the invoice type not is SUBSCRIPTION, refers to the STRIPE invoice ID
PerfectMoney payment ID linked to the invoice
ID for binance invoice
Full Binance QRCODE string
Checkout URL for Binance invoice
Whether or not the binance invoice was payed out
0, 1 Full CashApp QRCODE string
Unique note for the customer to leave in the CashApp payment
CashApp cashtag used to create the QRCODE
Cryptocurrency address linked to this invoice
Cryptocurrency amount converted based on crypto_exchange_rate
Cryptocurrency amount received, paid by the customer
The amount of money already sent for the crypto transaction's fee
The amount remaining to be paid for the crypto transaction's fee
URI used to create the QRCODE
The bitcoin lightning r hash if applicable
Crypto confirmations needed to process the invoice
The version of the Sellix Crypto Wallet being used
If true, an instant payout for this invoice's cryptocurrency address has been sent
If true, a scheduled payout for this invoice's cryptocurrency address has been sent
The payout type for the crypto
NOT_DEFINED If true, the Sellix fee_percentage has already been collected
If invoice type is MONTHLY_BILL, contains a breakdown of the fees that need to be collected
Customer country
Customer location
Customer IP
If true, a VPN or Proxy has been detected
Customer User Agent
The custom fields passed by the user at checkout. The type is map<string, string>
If true, this invoice has been created through the Developers API
If a product_id is not passed through the Developers API, a title must be specified
Additional webhook URL to which updates regarding this invoice will be sent
If present, the customer will be redirected to this URL after the invoice has been paid
DEPRECATED. Value is actually a stringified null
What cut does Sellix take out of the total. To learn more about Sellix fees please refer to https://sellix.io/fees
Amount of money left to process
Status of the invoice
PENDING, COMPLETED, VOIDED, WAITING_FOR_CONFIRMATIONS, PARTIAL, CUSTOMER_DISPUTE_ONGOING, REVERSED, REFUNDED, WAITING_SHOP_ACTION, PROCESSING If CART_PARTIAL_OUT_OF_STOCK, the invoice has been completed but some products in the cart were out of stock
PAYMENT_FAILED, CART_PARTIAL_OUT_OF_STOCK If the invoice is VOIDED and the product (or all the products in the cart) were out of stock, this additional status is set
PRODUCT_SOLD_OUT, CART_PRODUCTS_SOLD_OUT The environment the invoice was made under
PRODUCTION Day value, number
First three letters of the day name
First three letters of the month name
: Year number
Timestamp for the creation of the invoice
Timestamp, available of the last time the gateway has been updated
Date, available if the blacklist has been edited
User ID of the user who updated the invoice
Whether or not the invoice was created from a marketplace
0, 1 Payment ID for the squarespace payment method
The payment ID for the volume payment gateway
The reference ID for the volume payment gateway
The internal ID of the Sellix product plan associated to the subscription 2.0 product
Name of the merchant
If true, the merchant has enabled purchase with Credit Card through PayPal
If true, the merchant has enabled invoice shipment to the PayPal customer email
Was this page helpful?