Subscription Webhook

Subscription payment event payload example

Subscription Payment Events

Example and definition

Subscription Payment payload will be sent to you in real-time every time when the payment>>state field changes. Please ensure you have validated the challenge earlier provided and your reference number under the reference field.

Collection payload example

{
  "subscription_id": "EQ6JKR3",
  "reference": null,
  "customer": {
    "customer_id": "JROEWYK",
    "email": "[email protected]",
    "first_name": "jane",
    "last_name": "doe",
    "reference": null,
    "address": "Nairobi",
    "city": "Nairobi",
    "state": "Nairobi",
    "zipcode": "00100",
    "country": "KE",
    "created_at": "2025-03-25T16:32:44.570015+03:00",
    "updated_at": "2025-03-25T16:32:44.647262+03:00"
  },
  "plan": {
    "name": "standard",
    "plan_id": "VREM4YE",
    "frequency": 1,
    "frequency_unit": "M",
    "billing_cycles": 11,
    "currency": "KES",
    "amount": "1000.00",
    "reference": null,
    "plan_url": "https://sandbox.intasend.com/subscriptions/charge/VREM4YE/plan/",
    "redirect_url": null,
    "created_at": "2024-02-21T14:28:20.447057+03:00",
    "updated_at": "2024-07-11T13:24:02.982768+03:00"
  },
  "payment_method": "CARD-PAYMENT",
  "card_mask": "*******4242",
  "card_type": "Unknown",
  "card_expiry": "2025-03-25",
  "status": "ACTIVE",
  "start_date": "2025-03-25",
  "next_date": null,
  "completed_cycles": 1,
  "fail_reason": null,
  "setup_url": "https://sandbox.intasend.com/subscriptions/charge/EQ6JKR3:1tx4Ok:o3xRweQ8ghl_q8RN_-YiMRHRXDXPZaDp8Dhe7sVx1iQ",
  "redirect_url": null,
  "payments": [
    {
      "transaction_id": "ERG4X7Y",
      "invoice": {
        "invoice_id": "Y4684JQ",
        "state": "COMPLETE",
        "provider": "CARD-PAYMENT",
        "charges": "35.00",
        "net_amount": "965.00",
        "currency": "KES",
        "value": "1000.00",
        "account": "[email protected]",
        "api_ref": null,
        "clearing_status": "CLEARING",
        "mpesa_reference": null,
        "host": null,
        "card_info": {
          "bin_country": null,
          "card_type": null
        },
        "retry_count": 0,
        "failed_reason": null,
        "failed_code": null,
        "failed_code_link": null,
        "created_at": "2025-03-25T16:32:45.468207+03:00",
        "updated_at": "2025-03-25T16:32:54.183094+03:00"
      },
      "created_at": "2025-03-25T16:32:45.481380+03:00",
      "updated_at": "2025-03-25T16:32:53.893398+03:00"
    }
  ],
  "created_at": "2025-03-25T16:32:44.589226+03:00",
  "updated_at": "2025-03-25T16:32:54.203840+03:00",
  "challenge": "1234"
}

State fields reference

StateDescription
PENDINGThe transaction has just been logged. No action was taken.
PROCESSINGThe customer is in the process of making payment
COMPLETEThe transaction is complete - successful.
FAILEDThe transaction has failed - Check failed_reason field for more details