Get native store purchase eligibility | API reference

Description

Tells the client whether the caller may buy a native App Store or Google Play subscription for the organization and, when not, gives the reason. Any organization member may call it. The answer is a point-in-time decision; the claim and the store webhooks check eligibility again.

Authentication

Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.

Parameters

Name	In	Type	Details
`organizationId`	path	string	required lowercase UUID v4
`store`	query	string	required one of `app_store`, `play_store`, `test_store`

Responses

200 OK

application/jsonOrganizationNativePurchaseEligibilityResponse

Whether the caller may start a native store purchase for the organization, and why not when refused.

object
2 fields
- eligiblebooleanrequired
  - always true
- reasonnullrequired
Other fields are allowed.
object
2 fields
- eligiblebooleanrequired
  - always false
- reasonstringrequired
  - one of organization_admin_required, personal_organization_required, terminal_organization, stripe_subscription_conflict, existing_subscription_conflict, native_subscription_buyer_mismatch
Other fields are allowed.

Other responses

Status	Meaning	Body
400	Bad Request	`application/json`ErrorResponse
401	Unauthorized	`application/json`SessionFailureResponse
403	Forbidden	`application/json`ErrorResponse
404	Not Found	`application/json`ErrorResponse
409	Conflict	`application/json`ErrorResponse
500	Internal Server Error	`application/json`ErrorResponse
503	Service Unavailable	`application/json`ErrorResponse