Get Customer
Get a specific 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 street address additional info
Revenue customer has recieved from the affiliate program
The currency the customer gets reimbursed in for the affiliate program
Customer city
Customer country code
Timestamp for the creation of the customer
Customer email
Customer ID
ID of the customer who is affiliated to the purchase
If invoice type is MONTHLY_BILL, contains a breakdown of the fees that need to be collected
The timestamp for when the billing for the invoice ended
The timestamp for when the billing for the invoice started
Checkout URL for Binance invoice
ID for binance invoice
Whether or not the binance invoice was payed out
0, 1 Full Binance QRCODE string
The bitcoin lightning r hash if applicable
The blockchain of the crypto currency
ERC20, BEP20, TRC20, MATIC, SOL The amount of the discount applied to the bundle
The type of discount applied to the bundle
PERCENTAGE, FIXED Internal ID of the resource
The product IDs of the products in the bundle
The shop ID to which this bundle belongs
The title of the bundle
Unique ID of the bundle, used as reference across the API
Timestamp, available if the bundle has been updated
CashApp cashtag used to create the QRCODE
Unique note for the customer to leave in the CashApp payment
Full CashApp QRCODE string
Customer country
Unique ID of the coupon, if used, for the discount
Timestamp for the creation of the invoice
Cryptocurrency address linked to this invoice
Cryptocurrency amount converted based on crypto_exchange_rate
Crypto confirmations needed to process the invoice
Exchange rate between the cryptocurrency chosen (if any) and USD
The amount remaining to be paid for the crypto transaction's fee
The amount of money already sent for the crypto transaction's fee
If true, an instant payout for this invoice's cryptocurrency address has been sent
The payout type for the crypto
NOT_DEFINED Cryptocurrency amount received, paid by the customer
If true, a scheduled payout for this invoice's cryptocurrency address has been sent
URI used to create the QRCODE
The version of the Sellix Crypto Wallet being used
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 The custom fields passed by the user at checkout. The type is map<string, string>
Email of the customer
ID of the customer
First three letters of the day name
Day value, number
If true, this invoice has been created through the Developers API
If present, the customer will be redirected to this URL after the invoice has been paid
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
The oauth refresh token provided by discord during checkout
The oauth access token provided by discord during checkout
Timstamp for the expiration of the discord oauth tokens
If a coupon or volume_discount is used, the discount value presents the total amount of discount over the total cost of the invoice
Representation of how discount was applied to 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
The environment the invoice was made under
PRODUCTION Exchange rate between currency chosen and USD
If true, the Sellix fee_percentage has already been collected
What cut does Sellix take out of the total. To learn more about Sellix fees please refer to https://sellix.io/fees
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 Timestamp, available of the last time the gateway has been updated
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 Internal ID of the resource
Customer IP
Whether or not the invoice was created from a marketplace
0, 1 If true, a VPN or Proxy has been detected
DEPRECATED
DEPRECATED
DEPRECATED
Customer location
First three letters of the month name
Name of the merchant
How the invoice was created
STOREFRONT, API, EMBED DEPRECATED
DEPRECATED
DEPRECATED. Value is actually a stringified null
This field contains the API version of PayPal that is used
PayPal Alternative Payment Method name, such as iDEAL, used if gateway is PAYPAL
This field contains the PayPal authorization ID
This field contains the PayPal capture ID
Merchant PayPal email
If true and gateway is PAYPAL, the product will be shipped to the PayPal email on record instead of the customer email
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 PayPal order ID
This field is updated after the invoice is completed with the PayPal's email used for the purchase
ID of the paypal subscription
Link for the merchant to purchase the subscription from
PerfectMoney payment ID linked to the invoice
The ID of the wallet platform used during checkout
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 The description of the product addon
Internal ID of the resource
The price of the product addon
The product types for the product addon
The shop ID to which this addon belongs
The title of the product addon
Unique id of the resouce. The id for external usage through the API
Unique ID of the product linked to this invoice, if any
The internal ID of the Sellix product plan associated to the subscription 2.0 product
Product title
Product type
INFO_CARD, SERVICE, DYNAMIC, FILE, SERIALS, GAMING_RCON, SUBSCRIPTION, SUBSCRIPTION_V2 The id of the product the plan belongs to
Qauntity of product purchased
Unique ID of the recurring bill
If true, the merchant has enabled invoice shipment to the PayPal customer email
The shop ID to which this invoice belongs
If true, the merchant has enabled purchase with Credit Card through PayPal
Merchant Skrill email
Skrill link to redirect the customer to
Skrill unique ID linked to the invoice
Payment ID for the squarespace payment method
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 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 Client secret used to create the STRIPE paymentIntent
The ID of the stripe customer the invoice is for
Client ID used to create the STRIPE paymentIntent
If the invoice type not is SUBSCRIPTION, refers to the STRIPE invoice ID
If the invoice type is PRODUCT_SUBSCRIPTION or SUBSCRIPTION, refers to the STRIPE price ID
If the invoice type is SUBSCRIPTION, refers to the STRIPE subscription ID
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
Product type
INFO_CARD, SERVICE, DYNAMIC, FILE, SERIALS, GAMING_RCON, SUBSCRIPTION, SUBSCRIPTION_V2 The percentage of tax applied on the transaction
Amount of money left to process
Invoice total, unit_price*quantity where quantity is applicable
Invoice total in the currency chosen
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 Unique ID of the resource, used as reference across the API
Date, available if the blacklist has been edited
User ID of the user who updated the invoice
Customer User Agent
DEPRECATED
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 discount value applied from a volume_discount
The diplayed discount value applied from a volume_discount
The payment ID for the volume payment gateway
The reference ID for the volume payment gateway
: Year number
Customer name
Customer phone
Customer phone country code
Customer postal code
The shop ID to which this customer belongs
Customer state
Customer street address
When this subscription was canceled
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
If a coupon has been applied, its ID
Timestamp for the creation of the subscription
When the current billing period will end
The custom fields passed by the user at checkout. The type is map<string, string>
Customer street address additional info
Customer city
Customer country code
Customer email
ID of the store's customer
Customer name
Customer phone
Customer phone country code
Customer postal code
Customer state
Customer street address
Customer surname
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 ID of the legacy subscription
Origin of the subscription
STOREFRONT, PAYMENT_LINK, CHECKOUT The ID of the payment link used to pay the initial payment for this subscription
The ID of the PayPal account used to complete the subscription payments
The ID of the PayPal subscription
ID of the product subscription
ID of the subscriptions 2.0 active product plan
The title of the product plan for this subscription (only for type: v2)
ID of product subscription for subscriptions 2.0
Digital Software
If true, the renewal invoice has already been created
The shop ID to which this subscription belongs
Subscription status
PENDING, CANCELED, TRIALING, ACTIVE Details about the subscription status
PAYMENT_FAILED, CART_PARTIAL_OUT_OF_STOCK ID of the Stripe connected account
ID of the customer created on STRIPE
ID of the Stripe subscription
Whether or not the email for the trial period expiring has been sent
The subscription version
v1, v2 Whether or not the email for an upcoming renewal has been sent
When this subscription was last updated
Customer surname
Was this page helpful?