Skip to main content
Docs

BillingSubscriptionItemResource

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 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
    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
    pathRoot
    Type
    string
    Description

    The root path of the resource.

  • Name
    paymentSourceId
    Type
    string
    Description

    The unique identifier for the payment source being used for the subscription item.

  • 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
    status
    Type
    "active" | "ended" | "upcoming" | "past_due"
    Description

    The status of the subscription item.

Feedback

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

Last updated on