List all subscriptions

GET

/api/subscriptions

• Production server
• Development server

Parameters

Query Parameters

status

string

failed_payment

boolean

profile_id

string

entity_id

string

cancellation_reason_id

string

shopify_contract_id

string

search

string

next_billing_before

string

next_billing_after

string

next_delivery_before

string

next_delivery_after

string

next_production_before

string

next_production_after

string

created_before

string

created_after

string

page

number

limit

number

sort_by

string

Allowed values: created_at next_billing_date next_delivery_date next_production_date total status

sort_order

string

Allowed values: asc desc

Responses

200

object

data

required

Array<object>

object

number

required

string

id

required

string

status

required

string

Allowed values: ACTIVE PAUSED CANCELLED EXPIRED PAYMENT_FAILED

created_at

string

nullable

updated_at

string

nullable

is_active

required

boolean

account_id

required

string

can_cancel

required

boolean

profile_id

required

string

currency_code

required

string

subtotal

required

number

discount_amount

required

number

total

required

number

shopify_contract_id

number

nullable

billing_interval

required

string

billing_interval_count

required

number

next_billing_date

string

nullable

payment_day_of_week

number

nullable

next_delivery_date

string

nullable

next_production_date

string

nullable

delivery_slot_valid

required

boolean

cancelled_at

string

nullable

cancellation_reason

string

nullable

cancellation_reason_id

string

nullable

paused_at

string

nullable

payment_method_brand

string

nullable

payment_method_last4

string

nullable

current_billing_cycle

required

number

last_order

object

id

string

status

string

Allowed values: PENDING PAID PARTIALLY_REFUNDED REFUNDED CANCELLED

created_at

string

nullable

updated_at

string

nullable

account_id

string

profile_id

string

nullable

shopify_order_id

string

production_date

string

nullable

currency_code

string

fulfillment_status

string

Allowed values: FULFILLED UNFULFILLED PARTIALLY_FULFILLED

shopify_order_number

string

nullable

external_order_id

string

nullable

external_order_number

string

nullable

external_source

string

nullable

order_type

string

Allowed values: SUBSCRIPTION ONE_TIME UPSELL

is_checkout_order

boolean

tracking_number

string

nullable

tracking_company

string

nullable

tracking_url

string

nullable

subtotal

number

discount_amount

number

total

number

billing_date

string

nullable

delivery_date

string

nullable

order_created_at

string

nullable

profile

One of:

string

string

object

object

id

string

timezone

string

nullable

address1

string

nullable

address2

string

nullable

city

string

nullable

region

string

nullable

country

string

nullable

postal_code

string

nullable

created_at

string

nullable

updated_at

string

nullable

full_address

string

email_status

One of:

string

string

nullable

string

string

Allowed values: subscribed

string

string

Allowed values: unsubscribed

string

string

Allowed values: suppressed

email

string

external_id

string

nullable

first_name

string

nullable

last_name

string

nullable

full_name

string

phone_number

string

nullable

sms_status

One of:

string

string

nullable

string

string

Allowed values: subscribed

string

string

Allowed values: unsubscribed

string

string

Allowed values: suppressed

shopify_customer_id

string

nullable

subscriptions

One of:

string

string

Array<object>

Array<object>

object

delivery_slot

One of:

string

string

object

object

id

string

created_at

string

nullable

updated_at

string

nullable

is_active

boolean

position

number

label

string

start_time

string

end_time

string

is_all_day

boolean

delivery_day_id

string

can_pause

required

boolean

can_resume

required

boolean

can_reactivate

required

boolean

is_in_dunning

required

boolean

can_retry_payment

required

boolean

frequency_label

required

string

current_dunning_episode

string

nullable

profile

One of:

string

string

object

object

id

string

timezone

string

nullable

address1

string

nullable

address2

string

nullable

city

string

nullable

region

string

nullable

country

string

nullable

postal_code

string

nullable

created_at

string

nullable

updated_at

string

nullable

full_address

string

email_status

One of:

string

string

nullable

string

string

Allowed values: subscribed

string

string

Allowed values: unsubscribed

string

string

Allowed values: suppressed

email

string

external_id

string

nullable

first_name

string

nullable

last_name

string

nullable

full_name

string

phone_number

string

nullable

sms_status

One of:

string

string

nullable

string

string

Allowed values: subscribed

string

string

Allowed values: unsubscribed

string

string

Allowed values: suppressed

shopify_customer_id

string

nullable

entity

One of:

string

string

object

object

id

string

name

string

created_at

string

nullable

updated_at

string

nullable

is_active

boolean

account_id

string

profile_id

string

image_url

string

nullable

wizard_id

string

nullable

entity_type

string

attributes

string

entities

One of:

string

string

Array<object>

Array<object>

object

id

string

name

string

created_at

string

nullable

updated_at

string

nullable

is_active

boolean

account_id

string

profile_id

string

image_url

string

nullable

wizard_id

string

nullable

entity_type

string

attributes

string

meta

required

object

total

Total number of items

number

per_page

Items per page

number

current_page

Current page number

number

last_page

Last page number

number

first_page

First page number

number

first_page_url

URL for first page

string

last_page_url

URL for last page

string

next_page_url

URL for next page

string

nullable

previous_page_url

URL for previous page

string

nullable