Get Subscription
Get a specific subscription
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 of the resource
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 of the resource
Response
Internal ID of the resource
The ID of the product subscription
The ID of the shop to which this resource belongs
The ID of the customer who made the purchase
The email of the customer to which the invoice was sent to
The internal ID of the product
The internal ID of the product subscription plan
The status of the subscription
PENDING, COMPLETED, CANCELED, AWAIT_CANCELING, ACTIVE The timestamp of the subscription start date
The timestamp of the subscription end date
Whether or not the trial period was skipped
The reason the trial period was skipped
Whether or not the subscription's start has been processed
Whether or not the subscription's expiration event has been triggered
Timestamp for the creation of the query
Date, available if the query has been updated
The name of the shop the subscription was made for
The ID of the product the subscription is for
The internal shop ID to which this resource belongs
The ID of the customer who purchased the subscription plan
The unique ID of the subscription plan
The internal ID of the subscription product
The external ID of the subscription product
The external ID of the subscription product plan
The internal ID of the subscription plan
The unique ID of the subscription plan
The internal ID of the product subscription
The internal ID of the product plan
The internal ID of the payment interval
The status of the subscription
PENDING, COMPLETED, CANCELED, AWAIT_CANCELING, ACTIVE The date-time object of the subscription start date
The date-time object of the subscription end date
The internal ID of the payment method
How the invoice was created
STOREFRONT, API The gateway used for invoicing the subscription
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 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 blockchain of the crypto currency
ERC20, BEP20, TRC20, MATIC, SOL PayPal Alternative Payment Method name, such as iDEAL, used if gateway is PAYPAL
Whether or not the invoices will be sent to PayPal email
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 DEPRECATED: If gateway is LEX_HOLDINGS_GROUP, method to be used for the customer to pay
If a coupon has been applied, its ID
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
Whether or not the invoice has received developer confirmation
Arbitraty value set for development
Identifier for the payment link used to pay this invoice
Whether or not the purchase was made in a Sellixmarketplace
Comma separated list of gateways accepted for this invoice
ID of the discord account linked to the purchase at checkout
Oauth access token for the linked discord account
Oauth refresh token used to extend access to the linked discord account
Expiration timestamp for the discord customer oauth access
Whether or not the discord integration for the product has been removed
ID of the telegram account linked to the purchase at checkout
ID of the telegram group the account should be added to after payment confirmation
Whether or not the telegram integration for the product has been removed
The ID fo the customer who receives affiliate revenue from this purchase
The amount of affiliate revenue 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 type of affiliate revenue used
ONETIME_FULL, ONETIME_LIMIT, REPEAT_FULL, REPEAT_LIMIT Whether or not the subscription's start has been processed
Whether or not the subscription's expiration event has been triggered
Timestamp for the creation of the query
Date, available if the query has been updated
Internal ID of the resource
Unique id for the payment interval; used throughout Sellix's API
Internal ID for the product subscription
Internal ID for the subscription's product plan
Unique ID of the invoice created for the payment interval
Internal ID for the previous payment interval
The index of the payment interval
The time for when the payment interval started
The time for when the payment interval ended
The type of interval
PAYMENT The billing type of the payment interval
ADVANCE, ARREARS The time for when the payment was made
The number of payment attempts
The time for the last payment attempt
Payment details for the last payment
The time for the next payment interval
The status of the payment interval
PENDING, ACTIVE, AWAIT_CANCELING, CANCELED, COMPLETED Coupons used for the payment interval
The amount of customer balance used for the payment interval
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 Addons used for the payment interval
Whether or not the trial ending email has been sent
Whether or not the upcoming renewal email has been sent
Whether or not the start event has been processed
0, 1 Whether or not the end event has been processed
0, 1 The timestamp for when the payment interval was completed
The timestamp for when the payment interval was created
The timestamp for when the payment interval was last updated
The number of days before the payment interval is charged
The status of the invoice
PENDING, COMPLETED, VOIDED, WAITING_FOR_CONFIRMATIONS, PARTIAL, CUSTOMER_DISPUTE_ONGOING, REVERSED, REFUNDED, WAITING_SHOP_ACTION, PROCESSING 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 Sellix shop the payment interval was created for
Unique ID used within Sellix to identify customers across the API
Internal Sellix ID for the payment method
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 Sellix ID for the product
Unique ID of the product
Whether or not the product requires an auto payment method
0, 1 The stock of the subscription plan
The price of the subscription plan
The default discount applied to this plan
Whether a trial period is enabled for the subscription plan
0, 1 How many intervals should pass before the customer is invoiced
Was this page helpful?