Subscription events

These events are useful if you need to be notified whenever something happens with a subscription.

Please note that you can also use all Stripe webhooks if you need even more control.

  • subscription.created This event is triggered whenever a new subscription is created.
  • subscription.cancelled This event is triggered whenever a subscription is cancelled.
  • subscription.invoice.created This event is triggered whenever a new invoice is added to an existing subscription. This event will not trigger when a subscription is created, it will only trigger for upcoming invoices.

subscription.created

This event is triggered whenever a new subscription is created.

{
  "eventName": "subscription.created",
  "mode": "Live",
  "createdOn": "2017-10-04T19:19:04.9481223Z",
  "content": {
    "user": {
      "id": "8de09cbc-4797-421e-841b-156954ddbb61",
      "email": "geeks@snipcart.com",
      "creationDate": "2017-09-22T14:56:05.433Z",
      "mode": "Test",
      "gravatarUrl": "https://www.gravatar.com/avatar/b2b4677d71645916cbce0a893f7f6076?s=70&d=https%3a%2f%2fcdn.snipcart.com%2fassets%2fimages%2favatar.jpg",
      "billingAddress": {
        "fullName": "Geeks Snipcart",
        "firstName": "Geeks",
        "name": "Snipcart",
        "company": "Snipcart",
        "address1": "226 rue St-Joseph E",
        "address2": "",
        "fullAddress": "226 rue St-Joseph E",
        "city": "Quebec",
        "country": "CA",
        "postalCode": "G1K3A9",
        "province": "QC",
        "phone": "888 888 8888",
        "vatNumber": null
      },
      "shippingAddress": {
        "fullName": "Geeks Snipcart",
        "firstName": "Geeks",
        "name": "Snipcart",
        "company": "Snipcart",
        "address1": "226 rue St-Joseph E",
        "address2": "",
        "fullAddress": "226 rue St-Joseph E",
        "city": "Quebec",
        "country": "CA",
        "postalCode": "G1K3A9",
        "province": "QC",
        "phone": "888 888 8888",
        "vatNumber": null
      }
    },
    "initialOrderToken": "1912e4c1-d008-4c15-ab12-fe21a76d30d4",
    "schedule": {
      "interval": "Day",
      "intervalCount": 1,
      "trialPeriodInDays": null,
      "startsOn": "2017-10-04T00:00:00Z"
    },
    "itemId": "eb52e6e3-d8fa-4db4-b0a9-83c238ae1542",
    "id": "2df76eb5-410e-48ac-a130-163ab9377112",
    "name": "Plan with new syntax",
    "creationDate": "2017-10-04T19:18:53.01Z",
    "modificationDate": "2017-10-04T19:18:53.01Z",
    "cancelledOn": null,
    "amount": 30,
    "quantity": 1,
    "userDefinedId": "PLAN_NEW_SYNTAX",
    "totalSpent": 30,
    "status": "Paid",
    "gatewayId": null,
    "metadata": null,
    "cartId": null
  }
}

subscription.cancelled

This event is triggered when a subscription is cancelled, either by an admin or by the customer.

{
  "eventName": "subscription.cancelled",
  "mode": "Live",
  "createdOn": "2017-10-04T21:13:29.7014439Z",
  "content": {
    "user": {
      "id": "8de09cbc-4797-421e-841b-156954ddbb61",
      "email": "geeks@snipcart.com",
      "creationDate": "2017-09-22T14:56:05.433Z",
      "mode": "Test",
      "shippingAddressSameAsBilling": true,
      "gravatarUrl": "https://www.gravatar.com/avatar/b2b4677d71645916cbce0a893f7f6076?s=70&d=https%3a%2f%2fcdn.snipcart.com%2fassets%2fimages%2favatar.jpg",
      "billingAddress": {
        "fullName": "Geeks Snipcart",
        "firstName": "Geeks",
        "name": "Snipcart",
        "company": "Snipcart",
        "address1": "226 rue St-Joseph E",
        "address2": "",
        "fullAddress": "226 rue St-Joseph E",
        "city": "Quebec",
        "country": "CA",
        "postalCode": "G1K3A9",
        "province": "QC",
        "phone": "888 888 8888",
        "vatNumber": null
      },
      "shippingAddress": {
        "fullName": "Geeks Snipcart",
        "firstName": "Geeks",
        "name": "Snipcart",
        "company": "Snipcart",
        "address1": "226 rue St-Joseph E",
        "address2": "",
        "fullAddress": "226 rue St-Joseph E",
        "city": "Quebec",
        "country": "CA",
        "postalCode": "G1K3A9",
        "province": "QC",
        "phone": "888 888 8888",
        "vatNumber": null
      }
    },
    "initialOrderToken": "1912e4c1-d008-4c15-ab12-fe21a76d30d4",
    "firstInvoiceReceivedOn": null,
    "schedule": {
      "interval": "Day",
      "intervalCount": 1,
      "trialPeriodInDays": null,
      "startsOn": "2017-10-04T00:00:00Z"
    },
    "itemId": "eb52e6e3-d8fa-4db4-b0a9-83c238ae1542",
    "id": "2df76eb5-410e-48ac-a130-163ab9377112",
    "name": "Plan with new syntax",
    "creationDate": "2017-10-04T19:18:53.01Z",
    "modificationDate": "2017-10-04T19:18:53.01Z",
    "cancelledOn": "2017-10-04T21:13:29.4619355Z",
    "amount": 30,
    "quantity": 1,
    "userDefinedId": "PLAN_NEW_SYNTAX",
    "totalSpent": 30,
    "status": "Paid",
    "gatewayId": null,
    "metadata": null,
    "cartId": null
  }
}

subscription.invoice.created

This event is triggered whenever a new invoice is added to an existing subscription.

This event will not trigger when a subscription is created, it will only trigger for upcoming invoices.

{
  "eventName": "subscription.cancelled",
  "mode": "Live",
  "createdOn": "2017-10-04T21:13:29.7014439Z",
  "content": {
    "subscriptionId": "2df76eb5-410e-48ac-a130-163ab9377112",
    "amount": 30,
    "total": 30,
    "creationDate": "2017-10-04T19:18:53.01Z",
    "modificationDate": "2017-10-04T19:18:53.01Z",
    "subscription": {
      "user": {
        "id": "8de09cbc-4797-421e-841b-156954ddbb61",
        "email": "geeks@snipcart.com",
        "creationDate": "2017-09-22T14:56:05.433Z",
        "mode": "Test",
        "shippingAddressSameAsBilling": true,
        "gravatarUrl": "https://www.gravatar.com/avatar/b2b4677d71645916cbce0a893f7f6076?s=70&d=https%3a%2f%2fcdn.snipcart.com%2fassets%2fimages%2favatar.jpg",
        "billingAddress": {
            "fullName": "Geeks Snipcart",
            "firstName": "Geeks",
            "name": "Snipcart",
            "company": "Snipcart",
            "address1": "226 rue St-Joseph E",
            "address2": "",
            "fullAddress": "226 rue St-Joseph E",
            "city": "Quebec",
            "country": "CA",
            "postalCode": "G1K3A9",
            "province": "QC",
            "phone": "888 888 8888",
            "vatNumber": null
        },
        "shippingAddress": {
            "fullName": "Geeks Snipcart",
            "firstName": "Geeks",
            "name": "Snipcart",
            "company": "Snipcart",
            "address1": "226 rue St-Joseph E",
            "address2": "",
            "fullAddress": "226 rue St-Joseph E",
            "city": "Quebec",
            "country": "CA",
            "postalCode": "G1K3A9",
            "province": "QC",
            "phone": "888 888 8888",
            "vatNumber": null
        }
      },
      "initialOrderToken": "1912e4c1-d008-4c15-ab12-fe21a76d30d4",
      "firstInvoiceReceivedOn": null,
      "schedule": {
        "interval": "Day",
        "intervalCount": 1,
        "trialPeriodInDays": null,
        "startsOn": "2017-10-04T00:00:00Z"
      },
      "itemId": "eb52e6e3-d8fa-4db4-b0a9-83c238ae1542",
      "id": "2df76eb5-410e-48ac-a130-163ab9377112",
      "name": "Plan with new syntax",
      "creationDate": "2017-10-04T19:18:53.01Z",
      "modificationDate": "2017-10-04T19:18:53.01Z",
      "cancelledOn": "2017-10-04T21:13:29.4619355Z",
      "amount": 30,
      "quantity": 1,
      "userDefinedId": "PLAN_NEW_SYNTAX",
      "totalSpent": 30,
      "status": "Paid",
      "gatewayId": null,
      "metadata": null,
      "cartId": null
    }
  }
}