Sign in
Subscription

Get Active Package

Get the user's active package ID from their Metronome contract.

get/v1/subscription/active-package

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

package_idstring nullable

Active package ID if available

has_active_contractboolean required

Whether the user has an active contract

access_ends_atstring nullable

ISO 8601 timestamp when access ends, from Metronome contract ending_before (e.g. cancel at period end or trial end). Null if open-ended or not returned.

Changes