Skip to main content

Backend BillingSubscription object

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 BillingSubscription object is similar to the BillingSubscriptionResource object as it holds information about a subscription, as well as methods for managing it. However, the BillingSubscription object is different in that it is used in the Backend API and is not directly accessible from the Frontend API.

Properties

  • Name
    activeAt
    Type
    null | number
    Description

    The Unix timestamp (milliseconds) of when the Subscription became active.

  • Name
    createdAt
    Type
    number
    Description

    The Unix timestamp (milliseconds) of when the Subscription was created.

  • Name
    eligibleForFreeTrial
    Type
    boolean
    Description

    Whether the payer is eligible for a free trial.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the Subscription.

  • Name
    instanceId
    Type
    string
    Description

    The ID of the instance this Subscription belongs to.

  • Name
    nextPayment
    Type
    null | { amount: BillingMoneyAmount; date: number; perUnitTotals?: BillingPerUnitTotal[]; totals?: BillingTotals; }
    Description

    Information about the next scheduled payment for this Subscription.

  • Name
    nextPayment.amount
    Type
    BillingMoneyAmount
    Description

    The amount of the next payment.

  • Name
    nextPayment.date
    Type
    number
    Description

    The Unix timestamp (milliseconds) of when the next payment is scheduled.

  • Name
    nextPayment.perUnitTotals?
    Type
    BillingPerUnitTotal[]
    Description

    The per-unit cost breakdown for the next payment.

  • Name
    nextPayment.totals?
    Type
    BillingTotals
    Description

    The full cost breakdown for the next payment.

  • Name
    pastDueAt
    Type
    null | number
    Description

    The Unix timestamp (milliseconds) of when the Subscription became past due.

  • Name
    payerId
    Type
    string
    Description

    The ID of the payer for this Subscription.

  • Name
    status
    Type
    "abandoned" | "active" | "ended" | "canceled" | "incomplete" | "past_due"
    Description

    The current status of the Subscription.

  • Name
    subscriptionItems
    Type
    BillingSubscriptionItem[]
    Description

    All of the Subscription Items in this Subscription.

  • Name
    updatedAt
    Type
    number
    Description

    The Unix timestamp (milliseconds) of when the Subscription was last updated.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub