Skip to main content

BillingSubscriptionItemResource

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 BillingSubscriptionItemResource type represents an item in a subscription.

Properties

  • Name
    amount?
    Type
    BillingMoneyAmount
    Description

    The amount charged for the subscription item.

  • Name
    cancel
    Type
    (params: { orgId?: string; }) => Promise<DeletedObjectResource>
    Description

    A function to cancel the subscription item. Accepts the following parameters:

    • orgId? (string): The ID of the Organization to cancel the subscription item from.
  • Name
    canceledAt
    Type
    null | Date
    Description

    The date and time when the subscription item was canceled. null if the subscription item is not canceled.

  • Name
    createdAt
    Type
    Date
    Description

    The date and time when the subscription item was created.

  • Name
    credit?
    Type
    { amount: BillingMoneyAmount; }
    Description

    The credit from a previous purchase that is being applied to the subscription item.

  • Name
    credit.amount
    Type
    BillingMoneyAmount
    Description

    The amount of credit from a previous purchase that is being applied to the subscription item.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the subscription item.

  • Name
    isFreeTrial
    Type
    boolean
    Description

    Whether the subscription item is for a free trial.

  • Name
    nextPayment?
    Type
    null | BillingSubscriptionItemNextPayment
    Description

    Information about the next payment for this subscription item.

  • Name
    pastDueAt
    Type
    null | Date
    Description

    The date and time when the subscription item became past due. null if the subscription item is not past due.

  • Name
    periodEnd
    Type
    null | Date
    Description

    The date and time when the current billing period ends. null if not set.

  • Name
    periodStart
    Type
    Date
    Description

    The date and time when the current billing period starts.

  • Name
    plan
    Type
    BillingPlanResource
    Description

    The Plan associated with the subscription item.

  • Name
    planPeriod
    Type
    "month" | "annual"
    Description

    The billing period for the subscription item.

  • Name
    priceId
    Type
    string
    Description

    The ID of the price that this subscription item is associated with.

  • Name
    seats?
    Type
    BillingSubscriptionItemSeats
    Description

    Seat entitlement details for this subscription item. Only set for organization subscription items with seat-based billing.

  • Name
    status
    Type
    "active" | "ended" | "upcoming" | "past_due"
    Description

    The status of the subscription item.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub