Skip to main content

BillingPaymentResource

Important

Billing regularly introduces new features and UI changes to Clerk's components. If you'd like to remain on a specific version of Clerk's components or SDK, you can follow the steps in the pinning documentation.

The BillingPaymentResource type represents a payment attempt for a user or Organization.

Properties

  • Name
    amount
    Type
    BillingMoneyAmount
    Description

    The amount of the 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
    failedAt
    Type
    null | Date
    Description

    The date and time when the payment failed.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the payment.

  • Name
    paidAt
    Type
    null | Date
    Description

    The date and time when the payment was successfully completed.

  • Name
    paymentMethod
    Type
    null | BillingPaymentMethodResource
    Description

    The payment method being used for the payment, such as credit card or bank account.

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

    The current status of the payment.

  • Name
    subscriptionItem
    Type
    BillingSubscriptionItemResource
    Description

    The subscription item being paid for.

  • Name
    totals?
    Type
    null | BillingPaymentTotals
    Description

    Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals. Absent on older responses.

  • Name
    updatedAt
    Type
    Date
    Description

    The date and time when the payment was last updated.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub