Florality

GET

/api/v1/billing/entitlements

billing: 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.

Response schema

200

Successful response.

Name	Type	Required	Description
`planKey`	`string`	Required	Plan Key. Allowed values: "free", "pro", "pro_plus".
`limits`	`object`	Required	Limits.
`limits.templates`	`number \| null`	Required	Templates. Unlimited numeric limits are serialised as null in JSON.
`limits.fileUploadBytes`	`number`	Required	File Upload Bytes.
`limits.customFieldsPerMember`	`number \| null`	Required	Custom Fields Per Member. Unlimited numeric limits are serialised as null in JSON.
`limits.notesPerMember`	`number \| null`	Required	Notes Per Member. Unlimited numeric limits are serialised as null in JSON.
`limits.customColorSchemes`	`number`	Required	Custom Color Schemes.
`limits.uploadedCustomIcons`	`number`	Required	Uploaded Custom Icons.
`limits.uploadedCustomFonts`	`number`	Required	Uploaded Custom Fonts.
`limits.activeApiKeys`	`number`	Required	Active Api Keys. Max concurrently active Florality REST API keys.
`features`	`object`	Required	Features.
`features.canUseGifAvatar`	`boolean`	Required	Can Use Gif Avatar.
`features.canUseCustomColors`	`boolean`	Required	Can Use Custom Colors.
`features.canUseCustomIcons`	`boolean`	Required	Can Use Custom Icons.
`features.canUseAnimatedIcons`	`boolean`	Required	Can Use Animated Icons.
`features.canUseCustomFonts`	`boolean`	Required	Can Use Custom Fonts.
`features.canUseAvatarRingShapes`	`boolean`	Required	Can Use Avatar Ring Shapes.
`features.canUseProProfileExpression`	`boolean`	Required	Can Use Pro Profile Expression. Gradient ring, banner frame styles, overlays, hero layout, accent. Profile name typography is free.
`features.canUseProMemberListLayouts`	`boolean`	Required	Can Use Pro Member List Layouts. Polaroid rows + polaroid grid member list presets.
`features.canUseProColorPalettes`	`boolean`	Required	Can Use Pro Color Palettes. Exclusive built-in colour scheme IDs.
`features.canUseProIconTint`	`boolean`	Required	Can Use Pro Icon Tint. Tint recolour on uploaded static custom icons.
`features.canUseProProfileLookPresets`	`boolean`	Required	Can Use Pro Profile Look Presets. Cosmetic profile look bundles on member templates.
`features.canUseProPdfBranding`	`boolean`	Required	Can Use Pro Pdf Branding. Accent + logo strip on front-history PDF export.
`features.canUseProPlusProfileMotion`	`boolean`	Required	Can Use Pro Plus Profile Motion. Ring animation, hero name shimmer/glow, animated front badges.
`features.canUseProPlusBannerMedia`	`boolean`	Required	Can Use Pro Plus Banner Media. WebP/video loop member banners (GIF stays Pro via canUseGifAvatar).
`features.canUseProPlusRingShapes`	`boolean`	Required	Can Use Pro Plus Ring Shapes. Plus-only ring shapes (crown, moon, custom SVG mask).
`features.canUseProPlusBannerEffects`	`boolean`	Required	Can Use Pro Plus Banner Effects. Glass/blur overlay and profile background pattern presets.
`features.canUseProPlusColorPalettes`	`boolean`	Required	Can Use Pro Plus Color Palettes. Built-in colour schemes marked plusOnly.
`features.canUploadFrontIndicatorBackground`	`boolean`	Required	Can Upload Front Indicator Background.
`features.canUseProPlusSocialChrome`	`boolean`	Required	Can Use Pro Plus Social Chrome. Guestbook/music widget themes and friend vanity strip.
`features.canUseProPlusRingStrokeStyles`	`boolean`	Required	Can Use Pro Plus Ring Stroke Styles. Double stroke and glow ring layers (user-configurable).
`features.canUseProPlusIconLibraryOrg`	`boolean`	Required	Can Use Pro Plus Icon Library Org. Folders and tags for custom icon libraries.
`features.canUseProPlusCustomFieldBackgrounds`	`boolean`	Required	Can Use Pro Plus Custom Field Backgrounds. Pro Plus: per custom field card background image.
`features.canUseUnlimitedAnimatedFieldIcons`	`boolean`	Required	Can Use Unlimited Animated Field Icons. No per-member cap on animated field icons (Pro has a lower cap).
`features.canUseScheduledPluralKitSync`	`boolean`	Required	Can Use Scheduled Plural Kit Sync.
`features.canUseWikiLinksAndBacklinks`	`boolean`	Required	Can Use Wiki Links And Backlinks.
`features.canUseAdvancedFrontHistoryExport`	`boolean`	Required	Can Use Advanced Front History Export.
`features.canUseFrontSessionRules`	`boolean`	Required	Can Use Front Session Rules.
`features.canUseBulkSystemOps`	`boolean`	Required	Can Use Bulk System Ops.
`features.canUsePrivateShareLinks`	`boolean`	Required	Can Use Private Share Links.
`features.canUseCustomDashboardLayout`	`boolean`	Required	Can Use Custom Dashboard Layout.
`features.canUseOutboundWebhooks`	`boolean`	Required	Can Use Outbound Webhooks.
`features.canUseAdvancedApiKeys`	`boolean`	Required	Can Use Advanced Api Keys.
`features.canUseFrontTypeAnalytics`	`boolean`	Required	Can Use Front Type Analytics.
`lifetimeCustomFieldsUnlocked`	`boolean`	Required	Lifetime Custom Fields Unlocked. One-time Stripe purchase while on Free: custom fields per member become unlimited. Does not change `planKey` or other limits (notes, templates, etc.).
`donorSupporterUnlocked`	`boolean`	Required	Donor Supporter Unlocked. One-time donation flag (legacy perks merged in `mergeDonorSupporterUnlock`; base plans already unlimited templates + notes).

Errors

400 · JSON error: Request failed (BAD_REQUEST).
401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires billing: 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).

Request example

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

Shell

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

Responses

Successful response.

JSON

{
  "planKey": "free",
  "limits": {
    "templates": null,
    "fileUploadBytes": 10485760,
    "customFieldsPerMember": null,
    "notesPerMember": null,
    "customColorSchemes": 0,
    "uploadedCustomIcons": 0,
    "uploadedCustomFonts": 0,
    "activeApiKeys": 1
  },
  "features": {
    "canUseGifAvatar": false,
    "canUseCustomColors": true,
    "canUseCustomIcons": false,
    "canUseAnimatedIcons": false,
    "canUseCustomFonts": false,
    "canUseAvatarRingShapes": false,
    "canUseProProfileExpression": false,
    "canUseProMemberListLayouts": false,
    "canUseProColorPalettes": false,
    "canUseProIconTint": false,
    "canUseProProfileLookPresets": false,
    "canUseProPdfBranding": false,
    "canUseProPlusProfileMotion": false,
    "canUseProPlusBannerMedia": false,
    "canUseProPlusRingShapes": false,
    "canUseProPlusBannerEffects": false,
    "canUseProPlusColorPalettes": false,
    "canUploadFrontIndicatorBackground": false,
    "canUseProPlusSocialChrome": false,
    "canUseProPlusRingStrokeStyles": false,
    "canUseProPlusIconLibraryOrg": false,
    "canUseProPlusCustomFieldBackgrounds": false,
    "canUseUnlimitedAnimatedFieldIcons": false,
    "canUseScheduledPluralKitSync": false,
    "canUseWikiLinksAndBacklinks": false,
    "canUseAdvancedFrontHistoryExport": false,
    "canUseFrontSessionRules": false,
    "canUseBulkSystemOps": false,
    "canUsePrivateShareLinks": false,
    "canUseCustomDashboardLayout": false,
    "canUseOutboundWebhooks": false,
    "canUseAdvancedApiKeys": false,
    "canUseFrontTypeAnalytics": false
  },
  "lifetimeCustomFieldsUnlocked": false,
  "donorSupporterUnlocked": false
}

Example values are illustrative demo data.

Response schema

200

Successful response.

Name	Type	Required	Description
`planKey`	`string`	Required	Plan Key. Allowed values: "free", "pro", "pro_plus".
`limits`	`object`	Required	Limits.
`limits.templates`	`number \| null`	Required	Templates. Unlimited numeric limits are serialised as null in JSON.
`limits.fileUploadBytes`	`number`	Required	File Upload Bytes.
`limits.customFieldsPerMember`	`number \| null`	Required	Custom Fields Per Member. Unlimited numeric limits are serialised as null in JSON.
`limits.notesPerMember`	`number \| null`	Required	Notes Per Member. Unlimited numeric limits are serialised as null in JSON.
`limits.customColorSchemes`	`number`	Required	Custom Color Schemes.
`limits.uploadedCustomIcons`	`number`	Required	Uploaded Custom Icons.
`limits.uploadedCustomFonts`	`number`	Required	Uploaded Custom Fonts.
`limits.activeApiKeys`	`number`	Required	Active Api Keys. Max concurrently active Florality REST API keys.
`features`	`object`	Required	Features.
`features.canUseGifAvatar`	`boolean`	Required	Can Use Gif Avatar.
`features.canUseCustomColors`	`boolean`	Required	Can Use Custom Colors.
`features.canUseCustomIcons`	`boolean`	Required	Can Use Custom Icons.
`features.canUseAnimatedIcons`	`boolean`	Required	Can Use Animated Icons.
`features.canUseCustomFonts`	`boolean`	Required	Can Use Custom Fonts.
`features.canUseAvatarRingShapes`	`boolean`	Required	Can Use Avatar Ring Shapes.
`features.canUseProProfileExpression`	`boolean`	Required	Can Use Pro Profile Expression. Gradient ring, banner frame styles, overlays, hero layout, accent. Profile name typography is free.
`features.canUseProMemberListLayouts`	`boolean`	Required	Can Use Pro Member List Layouts. Polaroid rows + polaroid grid member list presets.
`features.canUseProColorPalettes`	`boolean`	Required	Can Use Pro Color Palettes. Exclusive built-in colour scheme IDs.
`features.canUseProIconTint`	`boolean`	Required	Can Use Pro Icon Tint. Tint recolour on uploaded static custom icons.
`features.canUseProProfileLookPresets`	`boolean`	Required	Can Use Pro Profile Look Presets. Cosmetic profile look bundles on member templates.
`features.canUseProPdfBranding`	`boolean`	Required	Can Use Pro Pdf Branding. Accent + logo strip on front-history PDF export.
`features.canUseProPlusProfileMotion`	`boolean`	Required	Can Use Pro Plus Profile Motion. Ring animation, hero name shimmer/glow, animated front badges.
`features.canUseProPlusBannerMedia`	`boolean`	Required	Can Use Pro Plus Banner Media. WebP/video loop member banners (GIF stays Pro via canUseGifAvatar).
`features.canUseProPlusRingShapes`	`boolean`	Required	Can Use Pro Plus Ring Shapes. Plus-only ring shapes (crown, moon, custom SVG mask).
`features.canUseProPlusBannerEffects`	`boolean`	Required	Can Use Pro Plus Banner Effects. Glass/blur overlay and profile background pattern presets.
`features.canUseProPlusColorPalettes`	`boolean`	Required	Can Use Pro Plus Color Palettes. Built-in colour schemes marked plusOnly.
`features.canUploadFrontIndicatorBackground`	`boolean`	Required	Can Upload Front Indicator Background.
`features.canUseProPlusSocialChrome`	`boolean`	Required	Can Use Pro Plus Social Chrome. Guestbook/music widget themes and friend vanity strip.
`features.canUseProPlusRingStrokeStyles`	`boolean`	Required	Can Use Pro Plus Ring Stroke Styles. Double stroke and glow ring layers (user-configurable).
`features.canUseProPlusIconLibraryOrg`	`boolean`	Required	Can Use Pro Plus Icon Library Org. Folders and tags for custom icon libraries.
`features.canUseProPlusCustomFieldBackgrounds`	`boolean`	Required	Can Use Pro Plus Custom Field Backgrounds. Pro Plus: per custom field card background image.
`features.canUseUnlimitedAnimatedFieldIcons`	`boolean`	Required	Can Use Unlimited Animated Field Icons. No per-member cap on animated field icons (Pro has a lower cap).
`features.canUseScheduledPluralKitSync`	`boolean`	Required	Can Use Scheduled Plural Kit Sync.
`features.canUseWikiLinksAndBacklinks`	`boolean`	Required	Can Use Wiki Links And Backlinks.
`features.canUseAdvancedFrontHistoryExport`	`boolean`	Required	Can Use Advanced Front History Export.
`features.canUseFrontSessionRules`	`boolean`	Required	Can Use Front Session Rules.
`features.canUseBulkSystemOps`	`boolean`	Required	Can Use Bulk System Ops.
`features.canUsePrivateShareLinks`	`boolean`	Required	Can Use Private Share Links.
`features.canUseCustomDashboardLayout`	`boolean`	Required	Can Use Custom Dashboard Layout.
`features.canUseOutboundWebhooks`	`boolean`	Required	Can Use Outbound Webhooks.
`features.canUseAdvancedApiKeys`	`boolean`	Required	Can Use Advanced Api Keys.
`features.canUseFrontTypeAnalytics`	`boolean`	Required	Can Use Front Type Analytics.
`lifetimeCustomFieldsUnlocked`	`boolean`	Required	Lifetime Custom Fields Unlocked. One-time Stripe purchase while on Free: custom fields per member become unlimited. Does not change `planKey` or other limits (notes, templates, etc.).
`donorSupporterUnlocked`	`boolean`	Required	Donor Supporter Unlocked. One-time donation flag (legacy perks merged in `mergeDonorSupporterUnlock`; base plans already unlimited templates + notes).

Errors

400 · JSON error

Request failed (BAD_REQUEST).

401 · JSON error

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

403 · JSON error

Requires billing: 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).

Responses

Successful response.

JSON

{
  "planKey": "free",
  "limits": {
    "templates": null,
    "fileUploadBytes": 10485760,
    "customFieldsPerMember": null,
    "notesPerMember": null,
    "customColorSchemes": 0,
    "uploadedCustomIcons": 0,
    "uploadedCustomFonts": 0,
    "activeApiKeys": 1
  },
  "features": {
    "canUseGifAvatar": false,
    "canUseCustomColors": true,
    "canUseCustomIcons": false,
    "canUseAnimatedIcons": false,
    "canUseCustomFonts": false,
    "canUseAvatarRingShapes": false,
    "canUseProProfileExpression": false,
    "canUseProMemberListLayouts": false,
    "canUseProColorPalettes": false,
    "canUseProIconTint": false,
    "canUseProProfileLookPresets": false,
    "canUseProPdfBranding": false,
    "canUseProPlusProfileMotion": false,
    "canUseProPlusBannerMedia": false,
    "canUseProPlusRingShapes": false,
    "canUseProPlusBannerEffects": false,
    "canUseProPlusColorPalettes": false,
    "canUploadFrontIndicatorBackground": false,
    "canUseProPlusSocialChrome": false,
    "canUseProPlusRingStrokeStyles": false,
    "canUseProPlusIconLibraryOrg": false,
    "canUseProPlusCustomFieldBackgrounds": false,
    "canUseUnlimitedAnimatedFieldIcons": false,
    "canUseScheduledPluralKitSync": false,
    "canUseWikiLinksAndBacklinks": false,
    "canUseAdvancedFrontHistoryExport": false,
    "canUseFrontSessionRules": false,
    "canUseBulkSystemOps": false,
    "canUsePrivateShareLinks": false,
    "canUseCustomDashboardLayout": false,
    "canUseOutboundWebhooks": false,
    "canUseAdvancedApiKeys": false,
    "canUseFrontTypeAnalytics": false
  },
  "lifetimeCustomFieldsUnlocked": false,
  "donorSupporterUnlocked": false
}

Example values are illustrative demo data.

Get billing entitlements

Parameters

Response schema

200

Errors

Request example

Responses

Get billing entitlements

Parameters

Response schema

200

Errors

Request example

Responses