Skip to main content

Types

NameProperties

PaymentInformation​

An object describing a user's payment information for a plugin, widget, or Community file.

user_idString
The ID of the user whose payment information was queried. Can be used to verify the validity of a response.
resource_idString
The ID of the plugin, widget, or Community file that was queried. Can be used to verify the validity of a response.
resource_typeString

The type of the resource, as a string enum.

  • PLUGIN
  • WIDGET
  • COMMUNITY_FILE
payment_statusPaymentStatus
The user's payment status on the resource.
date_of_purchaseString

The UTC ISO 8601 timestamp indicating when the user purchased the resource. No value is given if the user has never purchased the resource.

Note that a value will still be returned if the user had purchased the resource, but no longer has active access to it (e.g. purchase refunded, subscription ended).

PaymentStatus​

An object describing the user's payment status.

statusString

The current payment status of the user on the resource, as a string enum.

  • UNPAID
  • PAID
  • TRIAL

Note that querying your own resource will return as UNPAID. Additionally, the returned payment status does not update according to setPaymentStatusInDevelopment usage.