Skip to main content
POST
Query subscriptions

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Filter

active_at
string<date-time>

ActiveAt filters subscriptions that are active at the given time

billing_cadence
enum<string>[]

BillingCadence filters by billing cadence

Available options:
RECURRING
billing_period
enum<string>[]

BillingPeriod filters by billing period

Available options:
MONTHLY,
ANNUAL,
WEEKLY,
DAILY,
QUARTERLY,
HALF_YEARLY,
ONETIME
customer_id
string

CustomerID filters by customer ID

customer_ids
string[]

CustomerIDs filters by customer IDs

effective_date_for_update
string

EffectiveDateForUpdate selects subscriptions that need a billing-period pass on or before this time: current_period_end <= date OR (cancel_at IS NOT NULL AND cancel_at <= date). When nil, period/cancel cutoff logic is not applied by this field (see TimeRangeFilter for legacy period-end filtering).

end_time
string<date-time>
expand
string
external_customer_id
string

ExternalCustomerID filters by external customer ID

filters
object[]
invoicing_customer_ids
string[]

InvoicingCustomerIDs filters by invoicing customer ID

limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
parent_subscription_ids
string[]

ParentSubscriptionIDs filters by parent subscription IDs

plan_id
string

PlanID filters by plan ID

sort
object[]
start_time
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
subscription_ids
string[]
subscription_status
enum<string>[]

SubscriptionStatus filters by subscription status

Available options:
active,
paused,
cancelled,
incomplete,
trialing,
draft
subscription_type
enum<string>[]

SubscriptionType filters by subscription type

Available options:
standalone,
delegated_invoicing,
parent,
inherited,
grouped_invoicing
trial_end_due_lte
string<date-time>

TrialEndDueLTE, when set, restricts to subscriptions with trial_end not nil and trial_end <= trial_end_due_lte. Use with subscription_status trialing for trial-end cron processing.

with_line_items
boolean

WithLineItems includes line items in the response

Response

OK

items
object[]
pagination
object