Skip to content

List Subscriptions

GET
/v1/billing/subscriptions/

List all subscriptions (past + current) for this tenant.

limit
Limit

Records per page

integer
default: 50 >= 1 <= 200

Records per page

after
Any of:
string

Cursor from previous page’s next_cursor

Successful Response

PaginatedResponse[SubscriptionSummary]
object
data
required
Data
Array<object>
SubscriptionSummary

Lightweight Subscription projection for use in tenant context / list responses.

object
id
required
Id
string format: uuid
plan_name
required
Plan Name
string
paddle_status
required
Paddle Status
string
is_free_trial
required
Is Free Trial
boolean
start_date
required
Start Date
string format: date-time
end_date
Any of:
string format: date-time
billing_cycle
required
Billing Cycle
string
per_cycle_billing_amount
required
Per Cycle Billing Amount
integer
pagination
required
PaginationMeta

Pagination metadata included in list responses.

object
has_more
required
Has More
boolean
next_cursor
Any of:
string
total
Any of:
integer
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

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