Documentation

Fields

• giftCardBalance :: Maybe Float

  balance: The remaining credit on the recipient account associated with this gift card. Only has a value once the gift card has been redeemed. Can be used to create gift card balance displays for your customers.

• giftCardCanceled_at :: Maybe JsonDateTime

  canceled_at: When the gift card was canceled.

• giftCardCreated_at :: Maybe JsonDateTime

  created_at

• giftCardCurrency :: Maybe Text

  currency: 3-letter ISO 4217 currency code.

  Constraints:

  • Maximum length of 3
• giftCardDelivered_at :: Maybe JsonDateTime

  delivered_at: When the gift card was sent to the recipient by Recurly via email, if method was email and the "Gift Card Delivery" email template was enabled. This will be empty for post delivery or email delivery where the email template was disabled.

• giftCardDelivery :: Maybe GiftCardDelivery

  delivery: Gift card delivery details

• giftCardGifter_account_id :: Maybe Text

  gifter_account_id: The ID of the account that purchased the gift card.

  Constraints:

  • Maximum length of 13
• giftCardId :: Maybe Text

  id

  Constraints:

  • Maximum length of 13
• giftCardLiability_gl_account_id :: Maybe Text

  liability_gl_account_id: The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• giftCardObject :: Maybe Text

  object

• giftCardPerformance_obligation_id :: Maybe Text

  performance_obligation_id: The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• giftCardProduct_code :: Maybe Text

  product_code: The product code or SKU of the gift card product.

• giftCardPurchase_invoice_id :: Maybe Text

  purchase_invoice_id: The ID of the invoice for the gift card purchase made by the gifter.

  Constraints:

  • Maximum length of 13
• giftCardRecipient_account_id :: Maybe Text

  recipient_account_id: The ID of the account that redeemed the gift card redemption code. Does not have a value until gift card is redeemed.

  Constraints:

  • Maximum length of 13
• giftCardRedeemed_at :: Maybe JsonDateTime

  redeemed_at: When the gift card was redeemed by the recipient.

• giftCardRedemption_code :: Maybe Text

  redemption_code: The unique redemption code for the gift card, generated by Recurly. Will be 16 characters, alphanumeric, displayed uppercase, but accepted in any case at redemption. Used by the recipient account to create a credit in the amount of the `unit_amount` on their account.

• giftCardRedemption_invoice_id :: Maybe Text

  redemption_invoice_id: The ID of the invoice for the gift card redemption made by the recipient. Does not have a value until gift card is redeemed.

  Constraints:

  • Maximum length of 13
• giftCardRevenue_gl_account_id :: Maybe Text

  revenue_gl_account_id: The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• giftCardUnit_amount :: Maybe Float

  unit_amount: The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.

• giftCardUpdated_at :: Maybe JsonDateTime

  updated_at