StoreKit

Get StoreKit Subscription Status

Changed on

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

Request

  • Base URL
    https://api.zerosettle.io/v1
  • URL
    https://api.zerosettle.io/v1/iap/storekit-subscription-status
  • Auth
    API key in header X-ZeroSettle-Key

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

  • 689588dd867fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from boolean to integer for status

    • breaking

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8c7fa6fb5be3Revision changes
    • info

      endpoint added