List subscriptions
GET
http://localhost:8000/api/v1
/subscriptions
Retrieves a paginated list of subscriptions with optional filtering and sorting.
query Parameters
statusstringFilter by status (active, expired, etc.)
license_typestringFilter by license type
sort_typestringField to sort by
sort_directionstringSort direction (asc, desc)
pageintegerPage number
Responses
OK
begin_date_timestringcanceled_atstringcanceled_bystringend_date_timestringenvironmentstringfarm_idstringfarm_namestringfarm_owner_emailstringis_auto_renew_onbooleanlicense_durationstringlicense_typestringproduct_idstringproviderstringprovider_subscription_idstringstatusstringsubscription_idstringsupervisor_limitintegersupervisor_seat_usedintegerupdated_atstringworker_limitintegerworker_seat_usedinteger
Get subscription by ID
GET
http://localhost:8000/api/v1
/subscriptions/{subs_id}
Retrieves details of a specific subscription.
path Parameters
subs_idstring · requiredSubscription ID
Responses
OK
begin_date_timestringcanceled_atstringcanceled_bystringend_date_timestringenvironmentstringfarm_idstringfarm_namestringfarm_owner_emailstringis_auto_renew_onbooleanlicense_durationstringlicense_typestringproduct_idstringproviderstringprovider_subscription_idstringstatusstringsubscription_idstringsupervisor_limitintegersupervisor_seat_usedintegerupdated_atstringworker_limitintegerworker_seat_usedinteger
Verify a purchase from a payment provider
GET
http://localhost:8000/api/v1
/subscriptions/verify
Verifies a purchase token with Apple or Google and updates/creates the subscription for the farm.
query Parameters
farm_idstring · requiredFarm ID (UUID)
providerstring · requiredPayment provider (apple, google)
purchase_tokenstring · requiredPurchase token or Original Transaction ID
product_idstring · requiredProduct ID
Responses
OK
begin_date_timestringcanceled_atstringcanceled_bystringend_date_timestringenvironmentstringfarm_idstringfarm_namestringfarm_owner_emailstringis_auto_renew_onbooleanlicense_durationstringlicense_typestringproduct_idstringproviderstringprovider_subscription_idstringstatusstringsubscription_idstringsupervisor_limitintegersupervisor_seat_usedintegerupdated_atstringworker_limitintegerworker_seat_usedinteger