BillingAgreementCharge

Represents a scheduled billing event created from a billing agreement. Tracks processing state, retry schedule, and any linked transactions.

iduuidrequired

Unique identifier for the billing agreement charge.

Example: 019a72a0-4247-71c4-a4da-62b534d87af6

statestringrequired

Current processing state of the charge.

Possible values: [PROCESSING, FAILED, SUCCESS]

Example: PROCESSING

transactionIdstringnullable

Identifier of the successful transaction created for this charge, when available.

Example: LDG7M4WW44G

billingPlanIduuidrequired

Identifier for the associated billing plan.

Example: 019a729e-41c2-7d16-a1e2-fdb15a8146bb

billingAgreementIduuidrequired

Identifier for the billing agreement that produced this charge.

Example: 019a729e-2d93-7612-9329-8f783f66f834

deadlineAtdate-timenullable

Deadline for completing the charge before it is marked as failed.

Example: 2030-09-05T12:00:00Z

nextAttemptAtdate-timenullable

Timestamp of the next scheduled retry attempt, when additional retries are pending.

Example: 2030-08-01T12:00:00Z

createdAtdate-timerequired

Timestamp when the billing agreement charge was created.

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

BillingAgreementCharge

{
  "id": "019a72a0-4247-71c4-a4da-62b534d87af6",
  "state": "PROCESSING",
  "transactionId": "LDG7M4WW44G",
  "billingPlanId": "019a729e-41c2-7d16-a1e2-fdb15a8146bb",
  "billingAgreementId": "019a729e-2d93-7612-9329-8f783f66f834",
  "deadlineAt": "2030-09-05T12:00:00Z",
  "nextAttemptAt": "2030-08-01T12:00:00Z",
  "createdAt": "2030-07-29T15:51:28.071Z"
}