Sign in
StoreKit

Get StoreKit Subscription Status

Returns the current status of a StoreKit subscription by its original transaction ID. Useful for checking renewal state and expiry. The response includes normalized is_active and auto_renew_enabled booleans (SDK 1.2+); prefer these over the raw status/auto_renew_status fields for canonical access decisions.

get/iap/storekit-subscription-status

Query parameters

original_transaction_idstring required

The StoreKit original transaction ID for the subscription.

Response

Subscription status

statusinteger

Diagnostic only — SDK-collapsed Apple status: 1 (active) or 2 (not active). Prefer is_active for access decisions.

auto_renew_statusinteger

Diagnostic only — raw Apple autoRenewStatus integer (0 = off, 1 = on). Prefer auto_renew_enabled for canonical use.

expires_atstring date-time nullable

When the subscription expires or renews.

is_activeboolean required

Canonical active-entitlement flag. true when the Apple status code represents active access (active, grace period, or billing retry with access). Derived server-side from apple_status — use this instead of interpreting status yourself.

auto_renew_enabledboolean required

Canonical auto-renew flag. Equivalent to auto_renew_status == 1, exposed as a boolean for consistency with the rest of the API.

Changes

Changed in 3 of the 11 revisions of this API.47

  • 689588dd867f36See the full diff
    • ▲

      the response property expires_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the auto_renew_status response's property type/format changed from boolean/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the status response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ○

      removed the active enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the billing_grace_period enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the billing_retry enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the expired enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      added the required property auto_renew_enabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property is_active to the response with the 200 status

      response-required-property-added

  • 8c7fa6fb5be31See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 38 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog