BillingScheduleCreatedEvent
Notifies subscribers when the /commerce/invoicing/billing-schedules/actions/create request is complete. This object is available in API version 63.0 and later.
describeSObjects()
| Subscriber | Supported? |
|---|---|
| Apex Triggers | Yes |
| Flows | Yes |
| Processes | Yes |
| Pub/Sub API | Yes |
| Streaming API (CometD) | Yes |
/event/billingschedulecreatedevent.
No
This object is available when Billing is enabled.
-
Contains details about each order item in the
/commerce/invoicing/billing-schedules/actions/createrequest and any errors that occurred while processing the request. This object is included in anBillingScheduleCreatedEventmessage. You can’t subscribe to theBillSchdCreatedEventDetailplatform event directly. This object is available in API version 63.0 and later.
- Type: BillSchdCreatedEventDetail
- Properties: Nillable
- Description: One
BillingScheduleCreatedEventDetailentry is created for each order item in theBillingScheduleCreatedEventrequest. OneBillSchdCreatedEventDetailentry is created for each error that occurred.
- Type: string
- Properties: Nillable
- Description: Reserved for future use.
- Type: string
- Properties: Nillable
- Description: A universally unique identifier (UUID) that identifies a platform event message.
- 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.
- Type: string
- Properties: Nillable
- Description: ID returned in the
CreateBillingScheduleFromOrderItemresponse. Use this ID to identify theBillingScheduleCreatedEventfor a specific request.