FirstBillPaymentSetupEvent

Notifies subscribers when a first bill payment is set up. This object is available in API version 60.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Streaming API (CometD)

Subscription Channel

/event/

Event Delivery Allocation Enforced

Yes

Special Access Rules

FirstBillPaymentSetupEvent is available when B2B Commerce or D2C Commerce is enabled in your org.

Fields

CorrelationIdentifier

Type: string

Properties: Nillable

Description: Correlation ID passed in the invocable action input.

ErrorCode

Type: string

Properties: Nillable

Description: Error code for a failed first bill payment setup result.

ErrorMessage

Type: string

Properties: Nillable

Description: Error message for a failed first bill payment setup result.

EventUuid

Type: string

Properties: Nillable

Description: A universally unique identifier (UUID) that identifies a platform event message.

IsSuccess

Type: boolean

Properties: Defaulted on create

Description: Required. Shows whether the first bill payment is successfully set up. The default value is false.

OrderSummaryId

Type: reference

Properties: Nillable

Description: ID of the OrderSummary in the first bill payment setup process. This field is a relationship field.

Relationship Name: OrderSummary

Relationship Type: Lookup

Refers To: OrderSummary

ProcessingStage

Type: picklist

Properties: Nillable, Restricted picklist

Description: Processing Stage Enum. Possible values are:

BillingSchedulesCreation
FirstBillingRecovery—Available in API version 63.0 and later.
InvoiceGeneration
PaymentApplication
PaymentMethodAssociation
PreProcessing

ReplayId

Type: string

Properties: Nillable

Description: Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.

RequestIdentifier

Type: string

Properties: Nillable

Description: Request ID returned as an output of an invocable action.