Skip to main content
Docs

BillingPaymentResource

Warning

Billing is currently in Beta and its APIs are experimental and may undergo breaking changes. To mitigate potential disruptions, we recommend pinning your SDK and clerk-js package versions.

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
    Date
    Description

    The date and time when the payment failed.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the payment.

  • Name
    paidAt?
    Type
    Date
    Description

    The date and time when the payment was successfully completed.

  • Name
    pathRoot
    Type
    string
    Description

    The root path of the resource.

  • Name
    paymentSource
    Type
    BillingPaymentSourceResource
    Description

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

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

    The current status of the payment.

  • Name
    subscriptionItem
    Type
    BillingSubscriptionItemResource
    Description

    The subscription item being paid for.

  • Name
    updatedAt
    Type
    Date
    Description

    The date and time when the payment was last updated.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on