- 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`.
- Name
object
- Type
- string
- Description
Type of object is always
payment
.
required- Name
id
- Type
- string
- Description
Unique identifier for the payment.
Example:pay_0SNlurA049MEWV2HRA0slWFuS8DV
required- Name
amount
- Type
- object
- Description
- The total amount paid.
required- Name
discount
- Type
- object
- Description
- The total discount applied to this payment.
required- Name
disputeOutcome
- Type
- nullable string
- Description
The outcome of a payment dispute. Otherwise
null
.Allowed values:, lost, won
required- Name
failedAttempts
- Type
- integer
- Description
The number of failed payment attempts so far.
Example:3
>= 0
required- Name
failureCode
- Type
- nullable string
- Description
An error code indicating the reason for the payment failure.
Example:paymentCardDeclined
required- Name
failureMessage
- Type
- nullable string
- Description
A human-readable message indicating the reason for the payment failure.
Example:The card has been declined.
required- Name
invoiceNumber
- Type
- string
- Description
The number of the invoice from the payment provider
Example:B74BDB55-0555
required- Name
method
- Type
- nullable object
- Description
- The payment method describes how a payment can be made.
required- Name
reason
- Type
- string
- Description
The reason for this payment.
Allowed values:subscriptionCreation, subscriptionRenewal, other
required- Name
receipt
- Type
- nullable string
- Description
The URL of a PDF receipt. The URL and the content it links to might change whenever the payment transitions to another state. The URL is signed, but care should be taken when sharing it, as it is publicly accessible.
Example:https://files.gigs.com/receipts/pay_0SNlurA049MEWV2HRA0slWFuS8DV.pdf
required- Name
references
- Type
- array
- Description
List of payment references. Supported reference types are
order
andsubscription
.
required- Name
refunded
- Type
- object
- Description
- The sum of all refunds related to this payment. Cannot be greater than the paid sum.
required- Name
status
- Type
- string
- Description
The status of the payment. Can be
succeeded
,requiresConfirmation
,failed
,refunded
ordisputed
.Allowed values:succeeded, requiresConfirmation, failed, refunded, disputed, requiresPaymentMethod
required- Name
subtotal
- Type
- object
- Description
- The total amount to be paid before any applied discounts.
required- Name
taxes
- Type
- array PREVIEW
- Description
List of taxes.
Example:[object Object]
required- Name
total
- Type
- object PREVIEW
- Description
- The total amount paid.
required- Name
user
- Type
- object
- Description
required- Name
voucher
- Type
- nullable object
- Description
- Voucher applied to the payment.
required- Name
voucherCode
- Type
- nullable object
- Description
- Voucher code applied to the payment.
required- Name
attemptedAt
- Type
- string
- Description
Time when the payment was last attempted.
Example:2021-02-14T19:38:34Z
required- Name
createdAt
- Type
- string
- Description
Time when the payment was created.
Example:2021-02-14T19:38:34Z
required- Name
disputeClosedAt
- Type
- nullable string
- Description
Time when the payment dispute was closed. Otherwise
null
.Example:2021-02-14T19:38:34Z
required- Name
refundedAt
- Type
- nullable string
- Description
Time when the payment was fully refunded. Otherwise
null
.Example:2021-02-14T19:38:34Z
required
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.refunded
.
required- Name
version
- Type
- string
- Description
API version used to serialize the data and the event itself.
Default:2024-08-29
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.refunded",
"version": "2024-08-29"
}