Skip to content
BoxBilling

List subscriptions

GET
/v1/subscriptions/

List all subscriptions with pagination. Optionally filter by customer_id.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
skip
Skip
integer
0
limit
Limit
integer
default: 100 >= 1 <= 1000
order_by
Any of:
string
customer_id
Any of:
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response List Subscriptions V1 Subscriptions Get
Array<object>
SubscriptionResponse
object
id
required
Id
string format: uuid
external_id
required
External Id
string
customer_id
required
Customer Id
string format: uuid
plan_id
required
Plan Id
string format: uuid
status
required
SubscriptionStatus
string
Allowed values: pending active paused canceled terminated
billing_time
required
Billing Time
string
trial_period_days
required
Trial Period Days
integer
trial_ended_at
required
Any of:
string format: date-time
subscription_at
required
Any of:
string format: date-time
pay_in_advance
required
Pay In Advance
boolean
previous_plan_id
required
Any of:
string format: uuid
downgraded_at
required
Any of:
string format: date-time
on_termination_action
required
On Termination Action
string
started_at
required
Any of:
string format: date-time
ending_at
required
Any of:
string format: date-time
canceled_at
required
Any of:
string format: date-time
paused_at
required
Any of:
string format: date-time
resumed_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

401

Section titled “401 ”

Unauthorized – invalid or missing API key

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object