Sign in

v1

latestOpenAPI 3.0.02026-07-1319142308.8 KB
subscriptions

get/subscriptions

Query parameters

idstring text
user_idstring uuid
statusstring public.subscription_status
metadatastring jsonb
price_idstring text
quantitystring integer
cancel_at_period_endstring boolean
createdstring timestamp with time zone
current_period_startstring timestamp with time zone
current_period_endstring timestamp with time zone
ended_atstring timestamp with time zone
cancel_atstring timestamp with time zone
canceled_atstring timestamp with time zone
trial_startstring timestamp with time zone
trial_endstring timestamp with time zone
organization_idstring uuid
selectstring

Filtering Columns

orderstring

Ordering

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Prefer'count=none'

Preference

Response

OK

idstring text required

Note: This is a Primary Key.<pk/>

user_idstring uuid
status'trialing' | 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'unpaid' public.subscription_status
{"stackTrail":"components:schemas:subscriptions:properties:metadata","oasType":"schema","type":"unknown"}
price_idstring text

Note: This is a Foreign Key to prices.id.<fk table='prices' column='id'/>

quantityinteger
cancel_at_period_endboolean
createdstring timestamp with time zone required
current_period_startstring timestamp with time zone required
current_period_endstring timestamp with time zone required
ended_atstring timestamp with time zone
cancel_atstring timestamp with time zone
canceled_atstring timestamp with time zone
trial_startstring timestamp with time zone
trial_endstring timestamp with time zone
organization_idstring uuid required

Note: This is a Foreign Key to organization.id.<fk table='organization' column='id'/>