- Name
object
- Type
- string
- Description
Type of object is always
event
.
required- Name
id
- Type
- string
- Description
Unique identifier for the event.
Example:evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
required- Name
data
- Type
- object
- Description
- State of the latest payment attempt for a `subscription` or `order`.
required- Name
datacontenttype
- Type
- string
- Description
The RFC 2046 content-type.
Example:application/json
Default:application/json
required- Name
project
- Type
- string
- Description
Unique identifier for the project where the event occurred.
Example:gigs
required- Name
source
- Type
- string
- Description
URI identifying the event source.
Example:https://api.gigs.com
Default:https://api.gigs.com
required- Name
specversion
- Type
- string
- Description
The CloudEvents spec version.
Example:1.0
Default:1.0
required- Name
time
- Type
- string
- Description
Time when the event occurred.
Example:2022-03-16T14:12:42Z
required- Name
type
- Type
- string
- Description
Type is always
com.gigs.payment.requiresConfirmation
.
required- Name
version
- Type
- string
- Description
API version used to serialize the data and the event itself.
Default:2024-10-28
required
Example
{
"object": "event",
"id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
"data": {
"object": "payment",
"id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
"amount": {
"amount": 999,
"currency": "USD"
},
"discount": {
"amount": 999,
"currency": "USD"
},
"failedAttempts": 3,
"failureCode": "paymentCardDeclined",
"failureMessage": "The card has been declined.",
"invoiceNumber": "B74BDB55-0555",
"method": {
"object": "paymentMethod",
"id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
"brand": "visa",
"last4": "4242",
"provider": "stripe",
"status": "available",
"type": "card",
"user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
"createdAt": "2021-02-14T19:38:34Z"
},
"reason": "subscriptionCreation",
"receipt": "https://files.gigs.com/receipts/pay_0SNlurA049MEWV2HRA0slWFuS8DV.pdf",
"refunded": {
"amount": 999,
"currency": "USD"
},
"status": "succeeded",
"subtotal": {
"amount": 999,
"currency": "USD"
},
"taxes": [
{
"object": "tax",
"inclusive": false,
"name": "State Sales Tax",
"value": {
"amount": 90,
"currency": "USD"
}
}
],
"total": {
"amount": 999,
"currency": "USD"
},
"user": {
"object": "user",
"id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
"birthday": "2017-07-21",
"email": "jerry@example.com",
"emailVerified": true,
"fullName": "Jerry Seinfeld",
"preferredLocale": "en-US",
"createdAt": "2021-01-21T19:38:34Z"
},
"voucher": {
"object": "voucher",
"id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
"name": "Monthly Basic 15%",
"priceDiscount": {
"amount": 999,
"currency": "USD"
},
"priceDiscountPercentage": 30.12,
"recurrence": {
"type": "once"
},
"redemptions": 2,
"restrictions": {
"expiresAt": "2021-04-14T19:38:34Z"
},
"status": "available",
"createdAt": "2021-02-14T19:38:34Z"
},
"voucherCode": {
"object": "voucherCode",
"id": "voc_0SNlurA049MEWV0Q5vaTJnKoXc1v",
"code": "BlackFriday22",
"redemptions": 2,
"restrictions": {
"firstTimeTransaction": true,
"minimumPrice": {
"amount": 999,
"currency": "USD"
},
"expiresAt": "2021-04-14T19:38:34Z"
},
"status": "active",
"voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
"createdAt": "2021-02-14T19:38:34Z"
},
"attemptedAt": "2021-02-14T19:38:34Z",
"createdAt": "2021-02-14T19:38:34Z",
"disputeClosedAt": "2021-02-14T19:38:34Z",
"refundedAt": "2021-02-14T19:38:34Z"
},
"datacontenttype": "application/json",
"project": "gigs",
"source": "https://api.gigs.com",
"specversion": "1.0",
"time": "2022-03-16T14:12:42Z",
"type": "com.gigs.payment.requiresConfirmation",
"version": "2024-10-28"
}