The Subscription Object

string

ID of the legacy subscription

product_subscription_id

string

ID of product subscription for subscriptions 2.0

shop_id

integer

The shop ID to which this subscription belongs

product_id

string

ID of the product subscription

product_plan_id

string

ID of the subscriptions 2.0 active product plan

customer_id

string

ID of the store's customer

type

enum<string>

The subscription version

Available options:

v1,

v2

created_at

integer

Timestamp for the creation of the subscription

updated_at

integer

When this subscription was last updated

status

enum<string>

Subscription status

Available options:

PENDING,

CANCELED,

TRIALING,

ACTIVE

gateway

enum<string>

Gateway chosen for this subscription. A new invoice monthly will be created using this gayeway

Available options:

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

custom_fields

The custom fields passed by the user at checkout. The type is map<string, string>

coupon_id

string

The ID of the coupon used when paying for the subscription. Will be null if no coupon was used

current_period_end

integer

When the current billing period will end

upcoming_email_1_week_sent

boolean

Whether or not the email for an upcoming renewal has been sent

trial_period_ending_email_sent

boolean

Whether or not the email for the trial period expiring has been sent

renewal_invoice_created

boolean

If true, the renewal invoice has already been created

status_details

enum<string>

Details about the subscription status

Available options:

PAYMENT_FAILED,

CART_PARTIAL_OUT_OF_STOCK

canceled_at

integer

When this subscription was canceled

stripe_customer_id

string

ID of the customer created on STRIPE

stripe_account

string

ID of the Stripe connected account

stripe_subscription_id

string

ID of the Stripe subscription

paypal_account

string

The ID of the PayPal account used to complete the subscription payments

paypal_subscription_id

string

The ID of the PayPal subscription

product_title

string

Digital Software

product_plan_title

string

The title of the product plan for this subscription (only for type: v2)

cloudflare_image_id

string

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

string

Customer name

customer_surname

string

Customer surname

customer_phone

string

Customer phone

customer_phone_country_code

string

Customer phone country code

customer_country_code

string

Customer country code

customer_street_address

string

Customer street address

customer_additional_address_info

string

Customer street address additional info

customer_city

string

Customer city

customer_postal_code

string

Customer postal code

customer_state

string

Customer state

customer_email

string

Customer email

shop_name

string

The name of the shop the subscription was made for

invoices

object[]

invoices.id

integer

Internal ID of the resource

invoices.uniqid

string

Unique ID of the resource, used as reference across the API

invoices.recurring_billing_id

string

The Id of the legacy subscription

invoices.total

number

Invoice total, unit_price*quantity where quantity is applicable

invoices.total_display

number

Invoice total in the currency chosen

invoices.exchange_rate

number

Exchange rate between currency chosen and USD

invoices.crypto_exchange_rate

number

Exchange rate between the cryptocurrency chosen (if any) and USD

invoices.currency

enum<string>

Available currency

Available options:

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

invoices.shop_id

integer

The shop ID to which this invoice belongs

invoices.product_id

string

Unique ID of the product linked to this invoice, if any

invoices.gateway

enum<string>

Gateway chosen for this invoice. If null, the customer will be asked for a gateway in the Sellix hosted invoice page

Available options:

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

invoices.paypal_apm

enum<string>

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

Available options:

bancontact,

eps,

trustly,

mercado,

paylater,

sepa,

venmo,

blik,

giropay,

ideal,

mybank,

sofort,

przelewy24,

credit

invoices.stripe_apm

enum<string>

Stripe Alternative Payment Method name, such as iDEAL, used if gateway is STRIPE

Available options:

afterpay_clearpay,

alipay,

bancontact,

au_becs_debit,

boleto,

eps,

fpx,

giropay,

grabpay,

ideal,

klarna,

oxxo,

p24,

sofort,

wechat_pay

invoices.quantity

integer

Qauntity of product purchased

invoices.coupon_id

string

Unique ID of the coupon, if used, for the discount

invoices.status

enum<string>

Status of the invoice

Available options:

PENDING,

COMPLETED,

VOIDED,

WAITING_FOR_CONFIRMATIONS,

PARTIAL,

CUSTOMER_DISPUTE_ONGOING,

REVERSED,

REFUNDED,

WAITING_SHOP_ACTION,

PROCESSING

invoices.status_details

enum<string>

If CART_PARTIAL_OUT_OF_STOCK, the invoice has been completed but some products in the cart were out of stock

Available options:

PAYMENT_FAILED,

CART_PARTIAL_OUT_OF_STOCK

invoices.void_details

enum<string>

If the invoice is VOIDED and the product (or all the products in the cart) were out of stock, this additional status is set

Available options:

PRODUCT_SOLD_OUT,

CART_PRODUCTS_SOLD_OUT

invoices.discount

number

If a coupon or volume_discount is used, the discount value presents the total amount of discount over the total cost of the invoice

invoices.created_at

integer

Timestamp for the creation of the invoice

invoices.updated_at

integer

Date, available if the blacklist has been edited

invoices.crypto_amount

number

Cryptocurrency amount converted based on crypto_exchange_rate

invoices.crypto_received

number

Cryptocurrency amount received, paid by the customer

invoices.crypto_confirmations_needed

integer

Crypto confirmations needed to process the invoice

invoices.is_vpn_or_proxy

boolean

Whether the customer used a VPN or proxy when purchasing the subscription

invoices.developer_invoice

boolean

If true, this invoice has been created through the Developers API

invoices.paypal_email_delivery

boolean

If true and gateway is PAYPAL, the product will be shipped to the PayPal email on record instead of the customer email

invoices.fee_billed

boolean

Whether or not a fee was billed to the customer

invoices.crypto_scheduled_payout

boolean

Whether or not the payout is scheduled for the cryptocurrency

invoices.shop_paypal_credit_card

boolean

Whether or not to support credit cards on PayPal

invoices.shop_force_paypal_email_delivery

boolean

Whether or not to deliver the product to the PayPal email address

invoices.paypal_fee

integer

This field is updated after the invoice is completed with the fee taken by PayPal over the invoice total

invoices.fee_percentage

integer

What cut does Sellix take out of the total. To learn more about Sellix fees please refer to https://sellix.io/fees

invoices.day_value

integer

deprecated

DEPRECATED: Day value, number

invoices.year

integer

deprecated

DEPRECATED: Year number

invoices.updated_by

integer

User ID of the user who updated the invoice

approved_address

object

gateways_available

enum<string>[]

Gateways available for this invoice

Available options:

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

Was this page helpful?

Cancel Subscription Get Subscription

API Documentation

Information

Payments

Orders

Customers

Subscriptions 2.0

Subscriptions (legacy)

Licenses

Blacklists

Whitelists

Products

Categories

Groups

Coupons

Feedback

Queries