@rbxts/types 1.0.800 → 1.0.801

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -23063,19 +23063,31 @@ interface MarketplaceService extends Instance {
23063
23063
  /**
23064
23064
  * Tags: Yields
23065
23065
  */
23066
- GetSubscriptionProductInfoAsync(this: MarketplaceService, subscriptionId: string): object;
23066
+ GetSubscriptionProductInfoAsync(this: MarketplaceService, subscriptionId: string): SubscriptionInfo;
23067
23067
  /**
23068
23068
  * Tags: Yields
23069
23069
  */
23070
- GetUserSubscriptionDetailsAsync(this: MarketplaceService, user: Player, subscriptionId: string): object;
23070
+ GetUserSubscriptionDetailsAsync(
23071
+ this: MarketplaceService,
23072
+ user: Player,
23073
+ subscriptionId: string,
23074
+ ): UserSubscriptionDetails;
23071
23075
  /**
23072
23076
  * Tags: Yields
23073
23077
  */
23074
- GetUserSubscriptionPaymentHistoryAsync(this: MarketplaceService, user: Player, subscriptionId: string): unknown;
23078
+ GetUserSubscriptionPaymentHistoryAsync(
23079
+ this: MarketplaceService,
23080
+ user: Player,
23081
+ subscriptionId: string,
23082
+ ): Array<UserSubscriptionPaymentHistory>;
23075
23083
  /**
23076
23084
  * Tags: Yields
23077
23085
  */
23078
- GetUserSubscriptionStatusAsync(this: MarketplaceService, user: Player, subscriptionId: string): object;
23086
+ GetUserSubscriptionStatusAsync(
23087
+ this: MarketplaceService,
23088
+ user: Player,
23089
+ subscriptionId: string,
23090
+ ): UserSubscriptionStatus;
23079
23091
  /**
23080
23092
  * Returns whether the inventory of given [Player](https://developer.roblox.com/en-us/api-reference/class/Player) contains an asset, given the ID. This method can query for hats, models, sounds, etc. This function takes a small amount of time to send a request the Roblox website.
23081
23093
  *
@@ -3067,3 +3067,91 @@ interface VoxelChannels {
3067
3067
  */
3068
3068
  LiquidOccupancy: number;
3069
3069
  }
3070
+
3071
+ interface SubscriptionInfo {
3072
+ /**
3073
+ * The name of the subscription product.
3074
+ */
3075
+ Name: string;
3076
+ /**
3077
+ * The description of the subscription product.
3078
+ */
3079
+ Description: string;
3080
+ /**
3081
+ * The asset ID of the subscription product icon.
3082
+ */
3083
+ IconImageAssetID: number;
3084
+ /**
3085
+ * The duration of the subscription (for example, `Month`, `Year`, etc.).
3086
+ */
3087
+ SubscriptionPeriod: Enum.SubscriptionPeriod;
3088
+ /**
3089
+ * Localized price with the appropriate currency symbol for display (for example, `$4.99`). For users in unsupported countries, `DisplayPrice` returns a string without specific price information.
3090
+ */
3091
+ DisplayPrice: string;
3092
+ /**
3093
+ * Localized subscription period text for display (for example, `/month`). Can be used together with `DisplayPrice`.
3094
+ */
3095
+ DisplaySubscriptionPeriod: number;
3096
+ /**
3097
+ * Name of the subscription benefit provider (for example, the name of the associated experience).
3098
+ */
3099
+ SubscriptionProviderName: string;
3100
+ /**
3101
+ * True if the subscription product is available for sale.
3102
+ */
3103
+ IsForSale: boolean;
3104
+ /**
3105
+ * A number that can be used to compare the price of different subscription products. This is not the actual price of the subscription (for example, 499).
3106
+ */
3107
+ PriceTier: number;
3108
+ }
3109
+
3110
+ interface UserSubscriptionDetails {
3111
+ /**
3112
+ * Current state of this particular subscription.
3113
+ */
3114
+ SubscriptionState: Enum.SubscriptionState;
3115
+ /**
3116
+ * Renewal time for this current subscription. May be in the past if the subscription is in [SubscribedRenewalPaymentPending](https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#SubscribedRenewalPaymentPending) state. This field is will be `nil` if the subscription will not renew, is [Expired](https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#Expired), or the user never subscribed.
3117
+ */
3118
+ NextRenewTime: DateTime | undefined;
3119
+ /**
3120
+ * When this subscription expires. This field will be nil if the subscription is not cancelled or the user never subscribed.
3121
+ */
3122
+ ExpireTime: DateTime | undefined;
3123
+ /**
3124
+ * Table containing the details of the subscription expiration. This field will be `nil` if the subscription is not in the [Expired](https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#Expired) state. If populated, the table contains a ExpirationReason key of type [Enum.SubscriptionExpirationReason](https://create.roblox.com/docs/reference/engine/enums/SubscriptionExpirationReason) describing why the subscription is expired.
3125
+ */
3126
+ ExpirationDetails: ExpirationDetails | undefined;
3127
+ }
3128
+
3129
+ interface UserSubscriptionPaymentHistory {
3130
+ /**
3131
+ * [DateTime](https://create.roblox.com/docs/reference/engine/datatypes/DateTime) at the start of this particular subscription period.
3132
+ */
3133
+ CycleStartTime: DateTime;
3134
+ /**
3135
+ * [DateTime](https://create.roblox.com/docs/reference/engine/datatypes/DateTime) at the end of this particular subscription period.
3136
+ */
3137
+ CycleEndTime: DateTime;
3138
+ /**
3139
+ * [Enum.SubscriptionPaymentStatus.Paid](https://create.roblox.com/docs/reference/engine/enums/SubscriptionPaymentStatus#Paid) if the user paid for this particular subscription period. [Enum.SubscriptionPaymentStatus.Refunded](https://create.roblox.com/docs/reference/engine/enums/SubscriptionPaymentStatus#Refunded) if the user refunded this particular subscription period.
3140
+ */
3141
+ PaymentStatus: Enum.SubscriptionPaymentStatus;
3142
+ }
3143
+
3144
+ interface UserSubscriptionStatus {
3145
+ /**
3146
+ * True if the user's subscription is active.
3147
+ */
3148
+ IsSubscribed: boolean;
3149
+ /**
3150
+ * True if the user is set to renew this subscription after the current subscription period ends.
3151
+ */
3152
+ IsRenewing: boolean;
3153
+ }
3154
+
3155
+ interface ExpirationDetails {
3156
+ ExpirationReason: Enum.SubscriptionExpirationReason;
3157
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.800",
3
+ "version": "1.0.801",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },