Loyalty API

Type

Ownership2

Describes a customer's ownership instance of an asset.

Kind Type
Used in CustomerBalance3, EstimateAccrual1, LoggedOutBalance1, QueryOrderDetails1

When a customer unlocks an asset, they receive an ownership record. Each ownership tracks when it was obtained, how many uses remain, and when it expires or was deactivated. A customer can have multiple ownerships of the same asset if the asset is configured as recurring.

Properties

  • bhid bubbleflake required

    Internal Bubblehouse ID of the ownership.

  • obtained_at time required

    When the customer obtained this ownership.

  • remaining_uses integer optional

    Number of remaining uses for this ownership.

  • expires_at time optional

    When this ownership expires.

  • first_used_at time optional

    When this ownership was first used.

  • last_used_at time optional

    When this ownership was last used.

  • deactivated_at time optional

    When this ownership was deactivated.

  • deactivation_reason DeactivationReason1 optional

    Reason why this ownership was deactivated.

Previous
OrderLineDetails1