Skip to main content
Docs

CommercePaymentResource

The CommercePaymentResource type represents a payment attempt for a user or organization.

Properties

  • Name
    id
    Type
    string
    Description

    The unique identifier for the payment.

  • Name
    amount
    Type
    Description

    The monetary amount of the payment.

  • Name
    paidAt?
    Type
    Date | undefined
    Description

    The date and time when the payment was successfully completed. This property is undefined if the payment has not been paid yet.

  • Name
    failedAt?
    Type
    Date | undefined
    Description

    The date and time when the payment failed. This property is undefined if the payment has not failed.

  • Name
    updatedAt
    Type
    Date
    Description

    The date and time when the payment was last updated.

  • Name
    paymentSource
    Type
    | undefined
    Description

    The payment source being used for this payment attempt, such as credit card or bank account.

  • Name
    subscriptionItem
    Type
    Description

    The subscription item associated with this payment.

  • Name
    chargeType
    Type
    'checkout' | 'recurring'
    Description

    The type of charge this payment represents. Can be 'checkout' for one-time payments or 'recurring' for subscription payments.

  • Name
    status
    Type
    'pending' | 'paid' | 'failed'
    Description

    The current status of the payment attempt.

Feedback

What did you think of this content?

Last updated on