Skip to main content

Interface: GiftPurchase

A gift given to a customer.

Properties

amount

amount: string

The amount for the gift.


created_at

created_at: string

ISO date for when the gift was created.


credit_account_id

credit_account_id: number

The credit account id that the gift amount is linked to.


external_gift_product_id

external_gift_product_id: ExternalId

Store platform product id for the gift product


external_gift_variant_id

external_gift_variant_id: ExternalId

Store platform product variant id for the gift product


external_order_id

external_order_id: ExternalId

Order id in the store platform that purchased the gift.


external_redeemable_product_ids

external_redeemable_product_ids: ExternalId[]

List of platform product ids that that can be used when redeeming the gift. This list will be empty if any product can be redeemed or a collection should be used for the redemption


gift_currency

gift_currency: string

The currency the gift is in.


gift_note

gift_note: string

Note attached to the gift by the sender.


id

id: number

Unique numeric identifier for the Gift.


notification_scheduled_at

notification_scheduled_at: string

When the notification about the gift will be sent to the recipient.


notification_sent_at?

optional notification_sent_at: string

When the notification about the gift was sent to the recipient.


recipient_customer_id

recipient_customer_id: number

Gift recipient unique Recharge customer id


redeemable_collection_id?

optional redeemable_collection_id: number

A Recharge collection id that specifies which products this gift can be redeemed for.


redeemed_at?

optional redeemed_at: string

An ISO date for when the gift was redeemed


redemption_link: string

URI for the gift redemption page. This link includes an authenticated customer token. Login will be required if the token expires.


sender_customer_id

sender_customer_id: number

Gift sender unique Recharge customer id


sender_name

sender_name: string

The name the sender specified as who the gift is from. This will be the checkout customers name if not provided on checkout.


updated_at

updated_at: string

ISO date for when the gift was updated