Recurring Profiles

Webhook events available for Recurring Profiles


Event

This event is POST'd when a profile has been created or updated.

Payload

{
  "profiles": [
    {
      "id": "3VZE2NER",
      "profile_id": "3VZE2NER",
      "status": "Active",
      "payment_description": "$165.24\/mth (29th)",
      "started_on": "2023-05-29T18:21:56Z",
      "next_billing_date": "2023-07-29",
      "amount": 12,
      "currency": {
        "name": "US Dollar",
        "code": "USD",
        "iso_code": "USD",
        "symbol": "$",
        "rate": 1
      },
      "cover_costs_enabled": true,
      "cover_costs_amount": 15.24,
      "billing_period_description": "Monthly",
      "billing_period_day": "29th",
      "aggregate_amount": 165.24,
      "failed_payments": 0,
      "description": "General Membership - Monthly",
      "gl_code": null,
      "last_payment_due": null,
      "payment_method": {
        "display_name": "Visa",
        "account_type": "Visa",
        "account_number": "4*** **** **** 4242",
        "expires_on": "2026-02-28T00:00:00.000000Z",
        "is_expired": false,
        "is_deleted": false
      },
      "cancel_reason": null,
      "cycles_completed": 1,
      "cycles_remaining": null,
      "account": {
        "id": 15,
        "active": true,
        "first_name": "Steve",
        "last_name": "Arcand",
        "email": "email@example.com",
        "type": null,
        "email_opt_in": false,
        "vendor_contact_id": 3657,
        "billing_address": {
          "first_name": "Steve",
          "last_name": "Arcand",
          "company": null,
          "email": "email@example.com",
          "address1": "50 Rideau Street",
          "address2": null,
          "city": "Ottawa",
          "state": "ON",
          "zip": "K1N 9J7",
          "country": "CA",
          "phone": null
        },
        "shipping_address": {
          "first_name": "Steve",
          "last_name": "Arcand",
          "company": null,
          "email": "email@example.com",
          "address1": null,
          "address2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null,
          "phone": null
        },
        "created_at": "2022-01-31 19:32:29 UTC",
        "updated_at": "2024-02-16 10:05:08 UTC"
      }
    }
  ]
}