BillingAgreementEventData | ePay documentation

Payload delivered for subscription-billing.agreement-active.v1 and subscription-billing.agreement-stopped.v1 webhooks.

Payload delivered for `subscription-billing.agreement-active.v1` and `subscription-billing.agreement-stopped.v1` webhooks.

Represents an automated, recurring payment agreement between a merchant and a cardholder. Links a Subscription to a Billing Plan so ePay can manage scheduled charges and track billing status.

idstring

Required

Unique identifier for the billing agreement.

Format:

uuid

Example:

"019a729e-2d93-7612-9329-8f783f66f834"

billingPlanIdstring

Required

ID of the associated billing plan.

Format:

uuid

Example:

"019a729e-41c2-7d16-a1e2-fdb15a8146bb"

subscriptionIdstring

Required

ID of the linked subscription.

Format:

uuid

Example:

"019a729e-51ed-7426-b7c9-0e212b2d77d4"

sessionIdstring

Nullable

Optional session identifier. Is only present when the billing agreement was made using a session.

Format:

uuid

Example:

"019a729e-660a-7a05-90ad-5160ad0decc5"

customerIdstring

Nullable

Optional customer identifier.

Example:

"user-1"

nextChargeAtstring

Nullable

Date and time of the next charge, if scheduled. Will be null if the agreement is not in the ACTIVE state.

Date and time of the next charge, if scheduled. Will be null if the agreement is not in the `ACTIVE` state.

Format:

date-time

Example:

"2030-08-29T15:51:28.071Z"

lastChargeAtstring

Nullable

Date and time of the last charge, if available.

Format:

date-time

Example:

"2030-07-29T15:51:28.071Z"

desiredDateinteger

Nullable

Preferred day of the month for charging. This is the day of the month ePay will attempt to target for monthly payments. This ensures a consistent billing date across months, which might otherwise vary depending on number of days in the month or leap years. Only available for monthly intervals.

Example:

30

statestring

Required

Current state of the billing agreement.

Possible values:

"PENDING""ACTIVE""STOPPED"

stateChangedAtstring

Required

Timestamp when the billing agreement last changed state.

Format:

date-time

Example:

"2030-07-29T15:51:28.071Z"

referencestring

Nullable

Optional reference string.

Example:

"agreement-1"

createdAtstring

Required

Timestamp when the billing agreement was created.

Format:

date-time

Example:

"2030-07-29T15:51:28.071Z"

BillingAgreementEventData

{  "billingAgreement": {    "id": "019a729e-2d93-7612-9329-8f783f66f834",    "billingPlanId": "019a729e-41c2-7d16-a1e2-fdb15a8146bb",    "subscriptionId": "019a729e-51ed-7426-b7c9-0e212b2d77d4",    "sessionId": "019a729e-660a-7a05-90ad-5160ad0decc5",    "customerId": "user-1",    "nextChargeAt": "2030-08-29T15:51:28.071Z",    "lastChargeAt": "2030-07-29T15:51:28.071Z",    "desiredDate": 30,    "state": "PENDING",    "stateChangedAt": "2030-07-29T15:51:28.071Z",    "reference": "agreement-1",    "createdAt": "2030-07-29T15:51:28.071Z"  }}