ScheduledAgreementCancel

Field

Type

Description

event

string

The name of the event

transaction

string

Will always be blank since there is no onchain transaction

networkId

number

The ID of the network the event occurred on - 1, 5, 137, 80001 etc

networkName

string

The name of the network (e.g., Ethereum, Goerli, Polygon, etc.)

contractAddress

address

The address of the contract the event occurred in

email

string

The email address of the subscriber (if any)

company

string

Your company name

parent

string

The name of the parent company (if any)

entityId

string

The ID of the entity

agreementId

string

The agreement ID that was canceled

subscriber

string

The user's wallet address

agreementStartDate

number

The start date of the agreement - Unix time in seconds

eventDate

number

The date the subscription was canceled - Unix time in seconds

itemId

string

The ID of the item

itemName

string

The name of the item

refId

string

The reference ID passed in from checkout

cancellationEffectiveDate

number

The date the subscription will be cancelled. Unix time in seconds.

cancellationReason

string

Optional. Reason given for cancellation. May be system generated as well.

  • “Cancelled by Stripe” - Loop received a cancellation notification from Stripe and then emitted the "ScheduledAgreementCancel" event. This will occur when a subscription is cancelled in Stripe.
  • “Canceled due to uncollectible payment” - If the product is canceled via Loop's auto-cancel feature.

Example Payload:

{
      event: "ScheduledAgreementCancel",
      transaction: "-",
      networkId: 31337,
      networkName: "local",
      contractAddress: "0xfb255E7d519872D8E9E7BE8C79CE4b98444209Ce",
      email: "-",
      company: "Coin Currency LLC 94 48a916fe-c881-49aa-922e-53265185a11a (79faed4d-6606-455f-a8d8-d358c001d617)",
      parent: "-",
      entityId: "79faed4d-6606-455f-a8d8-d358c001d617",
      agreementId: "43bc9a0b-86b1-4a0a-8340-aef5585e2cd5",
      subscriber: "0x9E76932D7661C976a630aB9d06E45c0dc510A4b1",
      agreementStartDate: 1701457297,
      eventDate: 1701457297,
      itemId: "eb39844c-b5c7-4a42-a595-259e0fd9e6e2",
      itemName: "My Subscription",
      refId: "my-customer-ref",
      cancellationEffectiveDate: 1704067297,
      cancellationReason: "No longer need product"
}