Skip to main content
POST
/
webhook-events
/
payment.created
payment.created
curl --request POST \
  --url https://us.api.flexprice.io/v1/webhook-events/payment.created
{
  "event_type": "subscription.created",
  "payment": {
    "amount": "<string>",
    "attempts": [
      {
        "attempt_number": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "error_message": "<string>",
        "id": "<string>",
        "metadata": {},
        "payment_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "currency": "<string>",
    "destination_id": "<string>",
    "destination_type": "INVOICE",
    "error_message": "<string>",
    "failed_at": "2023-11-07T05:31:56Z",
    "gateway_metadata": {},
    "gateway_payment_id": "<string>",
    "gateway_tracking_id": "<string>",
    "id": "<string>",
    "idempotency_key": "<string>",
    "invoice_number": "<string>",
    "metadata": {},
    "payment_gateway": "<string>",
    "payment_method_id": "<string>",
    "payment_method_type": "CARD",
    "payment_status": "INITIATED",
    "payment_url": "<string>",
    "refunded_at": "2023-11-07T05:31:56Z",
    "save_card_and_make_default": true,
    "succeeded_at": "2023-11-07T05:31:56Z",
    "tenant_id": "<string>",
    "track_attempts": true,
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  }
}

Response

200 - application/json

Webhook payload

event_type
enum<string>
Available options:
subscription.created,
subscription.draft.created,
subscription.activated,
subscription.updated,
subscription.paused,
subscription.cancelled,
subscription.resumed,
subscription.phase.created,
subscription.phase.updated,
subscription.phase.deleted,
feature.created,
feature.updated,
feature.deleted,
feature.wallet_balance.alert,
entitlement.created,
entitlement.updated,
entitlement.deleted,
wallet.created,
wallet.updated,
wallet.terminated,
wallet.transaction.created,
payment.created,
payment.updated,
payment.failed,
payment.success,
payment.pending,
customer.created,
customer.updated,
customer.deleted,
invoice.update.finalized,
invoice.update.payment,
invoice.update.voided,
invoice.update,
invoice.payment.overdue,
wallet.credit_balance.dropped,
wallet.credit_balance.recovered,
wallet.ongoing_balance.dropped,
wallet.ongoing_balance.recovered,
subscription.renewal.due,
invoice.communication.triggered,
credit_note.created,
credit_note.updated
payment
object