interface APISubscription {
    canceled_at: null | string;
    country?: string;
    current_period_end: string;
    current_period_start: string;
    entitlement_ids: string[];
    id: string;
    renewal_sku_ids: null | string[];
    sku_ids: string[];
    status: SubscriptionStatus;
    user_id: string;
}

Properties

canceled_at: null | string

When the subscription was canceled

country?: string

ISO3166-1 alpha-2 country code of the payment source used to purchase the subscription. Missing unless queried with a private OAuth scope.

current_period_end: string

End of the current subscription period

current_period_start: string

Start of the current subscription period

entitlement_ids: string[]

List of entitlements granted for this subscription

id: string

ID of the subscription

renewal_sku_ids: null | string[]

List of SKUs that this user will be subscribed to at renewal

sku_ids: string[]

List of SKUs subscribed to

Current status of the subscription

user_id: string

ID of the user who is subscribed