subscription.gift_notification

The subscription.gift_notification event gets triggered when it's time to send a notification to the gift recipient, according to the gift date which has been set on the gift subscription during it's creation.

{
  "type": "subscription.gift_notification",
  "id": "evt_3hTzd468g6OH7qzVOZKHKMhL",
  "created": 1632153962,
  "data": {
    "object": {
      "object": "subscription",
      "id": 85,
      "address_id": 78,
      "address_shipping": {
        "object": "address",
        "id": 78,
        "city": "Montreal",
        "company": null,
        "country": "CA",
        "country_name": "Canada",
        "created_at": "2021-09-16T21:06:53.000000Z",
        "department": null,
        "first_name": "Heather",
        "is_default": true,
        "last_name": "Ramirez",
        "line1": "2 flowers st",
        "line2": "3",
        "postal_code": "A1A1A1",
        "salutation": null,
        "state": "QC",
        "state_name": "Quebec",
        "title": null,
        "type": "shipping",
        "updated_at": "2021-09-16T21:06:53.000000Z"
      },
      "agency_id": null,
      "backdate_start_date": null,
      "billing": "send_invoice",
      "billing_cycle_anchor": "2021-09-20T16:05:03.000000Z",
      "cancel_at": null,
      "cancel_at_period_end": 0,
      "cancel_reason": null,
      "canceled_at": "2021-09-20T16:05:08.000000Z",
      "coupon": null,
      "created": "2021-09-20T16:05:03.000000Z",
      "current_period_end": "2022-09-20T16:05:03.000000Z",
      "current_period_start": "2021-09-20T16:05:03.000000Z",
      "customer": {
        "object": "customer",
        "id": 87,
        "balance": 0,
        "created": "2021-09-16T21:03:23.000000Z",
        "currency": null,
        "default_source": null,
        "delinquent": false,
        "display_name": null,
        "email": "[email protected]",
        "email_confirm": null,
        "first_name": "Heather",
        "has_password": 0,
        "language": "en",
        "last_name": "Ramirez",
        "metadata": {
          "pelcro_account_id": "1",
          "pelcro_customer_id": "87"
        },
        "password_last_updated_at": null,
        "phone": null,
        "phone_confirm": null,
        "salutation": null,
        "title": null
      },
      "days_until_due": 30,
      "default_source": null,
      "default_tax_rates": null,
      "ended_at": "2021-09-20T16:05:08.000000Z",
      "gift_code": "CSG1HVVHA4",
      "gift_donor_subscription_id": null,
      "gift_message": "a gift message",
      "gift_notification_sent": 0,
      "gift_recipient_email": "[email protected]",
      "gift_recipient_first_name": "mun",
      "gift_recipient_last_name": "adomj",
      "gift_start_date": null,
      "is_gift_donor": 1,
      "is_gift_recipient": null,
      "is_redeemed": null,
      "latest_invoice": {
        "object": "invoice",
        "id": 101,
        "address_billing": null,
        "address_shipping": {
          "object": "address",
          "id": 78,
          "city": "Montreal",
          "company": null,
          "country": "CA",
          "country_name": "Canada",
          "created_at": "2021-09-16T21:06:53.000000Z",
          "department": null,
          "first_name": "Heather",
          "is_default": true,
          "last_name": "Ramirez",
          "line1": "2 flowers st",
          "line2": "3",
          "postal_code": "A1A1A1",
          "salutation": null,
          "state": "QC",
          "state_name": "Quebec",
          "title": null,
          "type": "shipping",
          "updated_at": "2021-09-16T21:06:53.000000Z"
        },
        "amount_due": 12000,
        "amount_paid": 0,
        "amount_remaining": 12000,
        "auto_advance": false,
        "billing": "send_invoice",
        "billing_address": null,
        "billing_reason": "subscription_create",
        "charge_id": null,
        "created": "2021-09-20T16:05:03.000000Z",
        "currency": "cad",
        "customer": {
          "object": "customer",
          "id": 87,
          "balance": 0,
          "created": "2021-09-16T21:03:23.000000Z",
          "currency": null,
          "default_source": null,
          "delinquent": false,
          "display_name": null,
          "email": "[email protected]",
          "email_confirm": null,
          "first_name": "Heather",
          "has_password": 0,
          "language": "en",
          "last_name": "Ramirez",
          "metadata": {
            "pelcro_account_id": "1",
            "pelcro_customer_id": "87"
          },
          "password_last_updated_at": null,
          "phone": null,
          "phone_confirm": null,
          "salutation": null,
          "title": null
        },
        "customer_address": null,
        "customer_shipping": null,
        "default_tax_rates": null,
        "deleted_at": null,
        "discount_id": null,
        "ending_balance": null,
        "finalized_at": null,
        "is_imported": null,
        "lines": null,
        "marked_uncollectible_at": null,
        "number": "EB61BE51-0007",
        "paid_at": null,
        "period_end": "2021-09-20T16:05:03.000000Z",
        "period_start": "2021-09-20T16:05:03.000000Z",
        "post_payment_credit_notes_amount": 0,
        "pre_payment_credit_notes_amount": 0,
        "purchase_order": null,
        "source": null,
        "starting_balance": 0,
        "status": "draft",
        "subtotal": 12000,
        "tax": null,
        "tax_percent": null,
        "total": 12000,
        "total_tax_amounts": null,
        "updated_at": "2021-09-20T16:05:58.000000Z",
        "voided_at": null
      },
      "plan": {
        "object": "plan",
        "id": 6,
        "active": "active",
        "amount": 12000,
        "currency": "cad",
        "entitlements": null,
        "interval": "year",
        "interval_count": 1,
        "nickname": "120.00$ / 1 year",
        "trial_period_days": 0,
        "product": {
          "object": "product",
          "id": 2,
          "type": "service",
          "active": "active",
          "address_required": true,
          "description": null,
          "livemode": false,
          "is_hidden": null,
          "name": "Agency - Print + Digital",
          "package_dimensions": null,
          "shippable": null,
          "statement_descriptor": null,
          "unit_label": null
        }
      },
      "quantity": 1,
      "schedules": null,
      "shipments_remaining": 12,
      "shipments_suspended_until": null,
      "shipments_undeliverable": false,
      "shipping_address": {
        "object": "address",
        "id": 78,
        "city": "Montreal",
        "company": null,
        "country": "CA",
        "country_name": "Canada",
        "created_at": "2021-09-16T21:06:53.000000Z",
        "department": null,
        "first_name": "Heather",
        "is_default": true,
        "last_name": "Ramirez",
        "line1": "2 flowers st",
        "line2": "3",
        "postal_code": "A1A1A1",
        "salutation": null,
        "state": "QC",
        "state_name": "Quebec",
        "title": null,
        "type": "shipping",
        "updated_at": "2021-09-16T21:06:53.000000Z"
      },
      "site_id": 1,
      "source": "Phone",
      "start_date": "2021-09-20T16:05:03.000000Z",
      "status": "canceled",
      "trial_end": null,
      "trial_start": null
    }
  }
}

Did this page help you?