Subscriptions | Public REST API | Florality | Florality

Object schema

Fields returned by Get subscription. Individual endpoint pages document their complete response shapes.

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.

Endpoints

1 operations

GETGet subscription/api/v1/subscriptions

Reference shortcuts

get subscription object schema endpoints