Get Subscription
Get a specific subscription
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
Uniqid of the resource
Response
The crypto address that was approved
The allowance of the approved address
The blockchain of the crypto currency
ERC20, BEP20, TRC20, MATIC, SOL The coin of the approved address
Timestamp, available if the approved address has been created
Internal ID of the resource
The recurring billing ID of the approval
The transaction ID of the approval
Timestamp, available if the approved address has been updated
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
The ID of the coupon used when paying for the subscription. Will be null if no coupon was used
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 Gateways available for this invoice
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
Unique ID of the coupon, if used, for the discount
Timestamp for the creation of the 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
Cryptocurrency amount received, paid by the customer
Whether or not the payout is scheduled for the cryptocurrency
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 DEPRECATED: Day value, number
If true, this invoice has been created through the Developers API
If a coupon or volume_discount is used, the discount value presents the total amount of discount over the total cost of the invoice
Exchange rate between currency chosen and USD
Whether or not a fee was billed to the customer
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 Internal ID of the resource
Whether the customer used a VPN or proxy when purchasing the subscription
If gateway is PAYPAL, a paypal_apm (PayPal Alternative Payment Method) can be specified. To retrieve the available PayPal APM for a specific customer session, please refer to the PayPal SDK using window.paypal.FUNDING and fundingSource to filter out available methods. You can also use our documentation on how to process white_label payments
bancontact, eps, trustly, mercado, paylater, sepa, venmo, blik, giropay, ideal, mybank, sofort, przelewy24, credit 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
Unique ID of the product linked to this invoice, if any
Qauntity of product purchased
The Id of the legacy subscription
Whether or not to deliver the product to the PayPal email address
The shop ID to which this invoice belongs
Whether or not to support credit cards on PayPal
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 Invoice total, unit_price*quantity where quantity is applicable
Invoice total in the currency chosen
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
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 DEPRECATED: Year number
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
The name of the shop the subscription was made for
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
Was this page helpful?