Skip to main content
Docs

BillingStatementResource

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 BillingStatementResource type represents a billing statement for a user or organization.

Properties

  • Name
    groups
    Type
    BillingStatementGroup[]
    Description

    An array of statement groups, where each group contains payment items organized by timestamp.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the statement.

  • Name
    pathRoot
    Type
    string
    Description

    The root path of the resource.

  • Name
    status
    Type
    "closed" | "open"
    Description

    The current status of the statement. Statements can be either 'open' (still accumulating charges) or 'closed' (finalized).

  • Name
    timestamp
    Type
    Date
    Description

    The date and time when the statement was created or last updated.

  • Name
    totals
    Type
    BillingStatementTotals
    Description

    An object containing the financial totals for the statement, including subtotal, grand total, tax total, credit, and past due amounts.

Feedback

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

Last updated on