GET

subscriptions

Guide to Query Params

The GET /subscriptions endpoint returns both legacy and 2.0 subscriptions when called without any parameters. The endpoint supports the following query parameters:

The version query parameter allows you to filter subscriptions by version. The possible versions are v1 and v2.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Sellix-Merchant

string

The name of the store to perform actions on via the API

Query Parameters

page

integer

If pagination is desired, the page to fetch of the response

version

enum<string>

Specify the type(s) of subscriptions to be returned

Available options:

v1,

v2

Response

200 - application/json

status

integer

data

object

data.subscriptions

object[]

data.subscriptions.id

string

ID of the legacy subscription

data.subscriptions.product_subscription_id

string

ID of product subscription for subscriptions 2.0

data.subscriptions.shop_id

integer

The shop ID to which this subscription belongs

data.subscriptions.product_id

string

ID of the product subscription

data.subscriptions.product_plan_id

string

ID of the subscriptions 2.0 active product plan

data.subscriptions.customer_id

string

ID of the store's customer

data.subscriptions.type

enum<string>

The subscription version

Available options:

v1,

v2

data.subscriptions.created_at

integer

Timestamp for the creation of the subscription

data.subscriptions.updated_at

integer

When this subscription was last updated

data.subscriptions.status

enum<string>

Subscription status

Available options:

PENDING,

CANCELED,

TRIALING,

ACTIVE

data.subscriptions.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

data.subscriptions.origin

enum<string>

Origin of the subscription

Available options:

STOREFRONT,

PAYMENT_LINK,

CHECKOUT

data.subscriptions.custom_fields

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

data.subscriptions.coupon_id

string

If a coupon has been applied, its ID

data.subscriptions.current_period_end

integer

When the current billing period will end

data.subscriptions.upcoming_email_1_week_sent

boolean

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

data.subscriptions.trial_period_ending_email_sent

boolean

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

data.subscriptions.renewal_invoice_created

boolean

If true, the renewal invoice has already been created

data.subscriptions.payment_link_id

string

The ID of the payment link used to pay the initial payment for this subscription

data.subscriptions.status_details

enum<string>

Details about the subscription status

Available options:

PAYMENT_FAILED,

CART_PARTIAL_OUT_OF_STOCK

data.subscriptions.canceled_at

integer

When this subscription was canceled

data.subscriptions.stripe_customer_id

string

ID of the customer created on STRIPE

data.subscriptions.stripe_account

string

ID of the Stripe connected account

data.subscriptions.stripe_subscription_id

string

ID of the Stripe subscription

data.subscriptions.paypal_account

string

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

data.subscriptions.paypal_subscription_id

string

The ID of the PayPal subscription

data.subscriptions.product_title

string

Digital Software

data.subscriptions.product_plan_title

string

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

data.subscriptions.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

data.subscriptions.customer_name

string

Customer name

data.subscriptions.customer_surname

string

Customer surname

data.subscriptions.customer_phone

string

Customer phone

data.subscriptions.customer_phone_country_code

string

Customer phone country code

data.subscriptions.customer_country_code

string

Customer country code

data.subscriptions.customer_street_address

string

Customer street address

data.subscriptions.customer_additional_address_info

string

Customer street address additional info

data.subscriptions.customer_city

string

Customer city

data.subscriptions.customer_postal_code

string

Customer postal code

data.subscriptions.customer_state

string

Customer state

data.subscriptions.customer_email

string

Customer email

message

string

log

object

error

string

env

string

Was this page helpful?

Get Subscription Create Subscription

API Documentation

Information

Payments

Orders

Customers

Subscriptions 2.0

Subscriptions (legacy)

Licenses

Blacklists

Whitelists

Products

Categories

Groups

Coupons

Feedback

Queries

List Subscriptions

Guide to Query Params

Authorizations

Headers

Query Parameters

Response

API Documentation

Information

Payments

Orders

Customers

Subscriptions 2.0

Subscriptions (legacy)

Licenses

Blacklists

Whitelists

Products

Categories

Groups

Coupons

Feedback

Queries

​Guide to Query Params

Authorizations

Headers

Query Parameters

Response

Guide to Query Params