Florality

GET

/api/v1/subscriptions

subscriptions: read1,000 requests/minute/key · all plans

Active API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.

Parameters

No path or query parameters.

Successful response.

Name	Type	Required	Description
`_id`	`string`	Required	Unique identifier.
`_creationTime`	`number`	Required	_creation Time.
`userId`	`string`	Required	Owning account identifier.
`clerk_user_id`	`string`	Optional	Clerk_user_id.
`stripe_customer_id`	`string`	Optional	Stripe_customer_id.
`stripe_subscription_id`	`string`	Optional	Stripe_subscription_id.
`stripe_price_id`	`string`	Optional	Stripe_price_id.
`plan_key`	`string`	Optional	Plan_key. Allowed values: "free", "pro", "pro_plus".
`subscription_status`	`string`	Optional	Subscription_status.
`current_period_end`	`number`	Optional	Current_period_end.
`cancel_at_period_end`	`boolean`	Optional	Cancel_at_period_end. Allowed values: false, true.
`default_payment_method_id`	`string`	Optional	Default_payment_method_id.
`last_webhook_event_id`	`string`	Optional	Last_webhook_event_id.
`lifetime_custom_fields_unlocked`	`boolean`	Optional	Lifetime_custom_fields_unlocked. Allowed values: false, true.
`donor_supporter_unlocked`	`boolean`	Optional	Donor_supporter_unlocked. Allowed values: false, true.
`createdAt`	`number`	Required	Creation time.
`updatedAt`	`number`	Required	Most recent update time.

400 · JSON error: Request failed (BAD_REQUEST).
401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires subscriptions: read; ownership or feature restrictions may also deny access.
429 · JSON error: API rate limit exceeded (1000 requests per minute). Retry shortly.
503 · JSON error: PostgreSQL is not configured (DATABASE_URL).

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell

curl --request GET 'https://floralitys.com/api/v1/subscriptions' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Successful response.

JSON

null

Example values are illustrative demo data.

Response schema

Successful response.

Name	Type	Required	Description
`_id`	`string`	Required	Unique identifier.
`_creationTime`	`number`	Required	_creation Time.
`userId`	`string`	Required	Owning account identifier.
`clerk_user_id`	`string`	Optional	Clerk_user_id.
`stripe_customer_id`	`string`	Optional	Stripe_customer_id.
`stripe_subscription_id`	`string`	Optional	Stripe_subscription_id.
`stripe_price_id`	`string`	Optional	Stripe_price_id.
`plan_key`	`string`	Optional	Plan_key. Allowed values: "free", "pro", "pro_plus".
`subscription_status`	`string`	Optional	Subscription_status.
`current_period_end`	`number`	Optional	Current_period_end.
`cancel_at_period_end`	`boolean`	Optional	Cancel_at_period_end. Allowed values: false, true.
`default_payment_method_id`	`string`	Optional	Default_payment_method_id.
`last_webhook_event_id`	`string`	Optional	Last_webhook_event_id.
`lifetime_custom_fields_unlocked`	`boolean`	Optional	Lifetime_custom_fields_unlocked. Allowed values: false, true.
`donor_supporter_unlocked`	`boolean`	Optional	Donor_supporter_unlocked. Allowed values: false, true.
`createdAt`	`number`	Required	Creation time.
`updatedAt`	`number`	Required	Most recent update time.

Errors

400 · JSON error

Request failed (BAD_REQUEST).

401 · JSON error

Missing or invalid API key. Use Authorization: Bearer <token>.

403 · JSON error

Requires subscriptions: read; ownership or feature restrictions may also deny access.

429 · JSON error

API rate limit exceeded (1000 requests per minute). Retry shortly.

503 · JSON error

PostgreSQL is not configured (DATABASE_URL).