rozod
    Preparing search index...

    Variable getCloudV2UniversesUniverseIdSubscriptionProductsSubscriptionProductIdSubscriptionsSubscriptionIdConst Param

    getCloudV2UniversesUniverseIdSubscriptionProductsSubscriptionProductIdSubscriptionsSubscriptionId: EndpointGeneric<
        {
            subscription_id: string;
            subscription_product_id: string;
            universe_id: string;
            view?: "VIEW_UNSPECIFIED"
            | "FULL"
            | "BASIC";
        },
        {
            active: boolean;
            createTime: string;
            expirationDetails: {
                reason: | "EXPIRATION_REASON_UNSPECIFIED"
                | "PRODUCT_INACTIVE"
                | "PRODUCT_DELETED"
                | "SUBSCRIBER_CANCELLED"
                | "SUBSCRIBER_REFUNDED"
                | "LAPSED";
            };
            expireTime: string;
            lastBillingTime: string;
            nextRenewTime: string;
            path: string;
            paymentProvider: | "PAYMENT_PROVIDER_UNSPECIFIED"
            | "STRIPE"
            | "APPLE"
            | "GOOGLE"
            | "ROBLOX_CREDIT";
            purchasePlatform: "PURCHASE_PLATFORM_UNSPECIFIED"
            | "DESKTOP"
            | "MOBILE";
            state:
                | "STATE_UNSPECIFIED"
                | "SUBSCRIBED_WILL_RENEW"
                | "SUBSCRIBED_WILL_NOT_RENEW"
                | "SUBSCRIBED_RENEWAL_PAYMENT_PENDING"
                | "EXPIRED";
            updateTime: string;
            user: string;
            willRenew: boolean;
        },
        undefined,
    > = ...

    BETA

    Get the subscription.

    The universe.subscription-product.subscription:read scope only allows reading subscriptions of the user making the request. Because of this, the subscription ID must match the user ID of the user making the request. Note that this scope might be more relevant for OAuth 2.0 apps.

    To read all subscriptions made by users for a particular universe, use the universe:write scope instead.

    Scopes: universe:write, universe.subscription-product.subscription:read Engine: Not available in-engine

    universe_id The universe ID. subscription_product_id The subscription-product ID. subscription_id The subscription ID. view The view in which to retrieve the subscription.

    Supports BASIC and FULL.

    Defaults to BASIC.

    Possible values:

    Value Description
    VIEW_UNSPECIFIED The subscription view is not specified; the default will be used.
    BASIC Includes only the active and renewing fields.
    FULL Includes all fields.

    Settings

    Member Visibility