PayPal · Schema
Failed Payment Details
The details for the failed payment of the subscription.
BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| amount | object | The failed payment amount. |
| time | object | The date and time when the failed payment was made, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). |
| reason_code | string | The reason code for the payment failure. |
| next_payment_retry_time | object | The time when the retry attempt for the failed payment occurs, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/failed_payment_details",
"title": "Failed Payment Details",
"description": "The details for the failed payment of the subscription.",
"type": "object",
"properties": {
"amount": {
"description": "The failed payment amount.",
"readOnly": true,
"$ref": "#/components/schemas/money"
},
"time": {
"description": "The date and time when the failed payment was made, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
"readOnly": true,
"$ref": "#/components/schemas/date_time"
},
"reason_code": {
"type": "string",
"description": "The reason code for the payment failure.",
"minLength": 1,
"maxLength": 120,
"pattern": "^[A-Z_]+$",
"readOnly": true,
"enum": [
"PAYMENT_DENIED",
"INTERNAL_SERVER_ERROR",
"PAYEE_ACCOUNT_RESTRICTED",
"PAYER_ACCOUNT_RESTRICTED",
"PAYER_CANNOT_PAY",
"SENDING_LIMIT_EXCEEDED",
"TRANSACTION_RECEIVING_LIMIT_EXCEEDED",
"CURRENCY_MISMATCH"
]
},
"next_payment_retry_time": {
"description": "The time when the retry attempt for the failed payment occurs, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
"readOnly": true,
"$ref": "#/components/schemas/date_time"
}
},
"required": [
"amount",
"time"
]
}