Premium Asset Object

An asset is a materialized view of a Premium subscription and the related product. The product may be saved in the Premium Product Catalog.

Properties
accountOwnerIdstringformat GUID

ID of the Wix account that owns the asset. Can be a workspace ID or an account ID.

billingCycleCycle

Information about the asset's billing cycle.

billingReferenceBillingReference

Information about the asset's billing provider.

createdDatestringRead-onlyformat date-time

Date and time the asset was created in YYYY-MM-DDThh:mm:ss.sssZ format.

deliveryCompleteboolean

Whether the asset is actually available to the owner. Relevant only for domains with status "ACTIVE".

freeTrialDataFreeTrialData

Information about the asset's free trial or deferred billing state. Populated when the asset was purchased with a free trial, and also while billing is deferred pending an external activation. Remains populated after a trial ends, with inFreeTrialPeriod set to false.

moneyBackPeriodEndDatestringformat date-time

End date and time of the refund period in YYYY-MM-DDThh:mm:ss.sssZ format. Available only for products that support a money back policy.

pendingChangesServicePendingChanges

Information about changes to the asset that are still pending. Available only for {"status": "PENDING"}.

premiumIdstringRead-onlyformat GUID

Premium ID of the asset. Available for all product types.

  • For subscriptions identical to the ID of the subscription.
  • For domains identical to the registration ID.
  • For digital goods identical to the ID of the digital goods package.
  • For mailboxes identical to the Google mailbox GUID.
productDataProductData

Information about the Premium entity related to the asset. Available for all assets.

renewalTypestring

Information about whether the asset renews at the end of the current billing cycle.

seatsintegerminimum 1maximum 500format int32

Number of seats/licenses for the subscription. Null means the asset doesn't support seats.

siteDataSiteData

Information about the site to which the asset is connected to.

sourceEntityCreatedDatestringRead-onlyformat date-time

Date and time the source entity was created in YYYY-MM-DDThh:mm:ss.sssZ format.

sourceEntityOriginalCreationDatestringRead-onlyformat date-time

Date and time the original source entity was created in YYYY-MM-DDThh:mm:ss.sssZ format. Differs from source_entity_created_date when the subscription was created by transfer, and is equal when created by purchase.

statusstring

Status of the asset.

subscriptionEndDatestringformat date-time

Date and time the asset expires in YYYY-MM-DDThh:mm:ss.sssZ format. Available only for {"renewalType": "AUTO_RENEW_OFF"}.

One Of
digitalGoodsDataDigitalGoodsData

Information about the digital good. Available only for digital goods.

domainsDataDomainData

Information about the domain. Available only for domains.

mailboxesDataMailboxData

Information about the business email. Available only for mailboxes.

typeSpecificFieldsTypeSpecificFields

Custom fields defined by the product schema. These key-value pairs are copied from the subscription's metadata field, which usually originates from the billing order's external params. Useful for storing product-specific data like domain names for mailboxes.

updatedDatestringRead-onlyformat date-time

Date and time the asset was last updated in YYYY-MM-DDThh:mm:ss.sssZ format.

wixBillingDetailsBillingDetails

Information about the asset's billing.

Did this help?