Skip to main content
Docs

CommerceSubscriptionResource

Warning

This API is experimental and subject to change while Clerk Billing is under Beta. To mitigate potential disruptions, we recommend pinning your SDK and clerk-js package versions.

The CommerceSubscriptionResource type represents a subscription to a plan.

Properties

  • Name
    id
    Type
    string
    Description

    The unique identifier for the subscription.

  • Name
    activeAt
    Type
    Date
    Description

    The date when the subscription became active.

  • Name
    createdAt
    Type
    Date
    Description

    The date when the subscription was created.

  • Name
    nextPayment
    Type
    { amount: CommerceMoney; date: Date } | null
    Description

    Information about the next payment, including the amount and the date it's due. Returns null if there is no upcoming payment.

  • Name
    pastDueAt
    Type
    Date | null
    Description

    The date when the subscription became past due, or null if it's not past due.

  • Name
    status
    Type
    'active' | 'past_due'
    Description

    The current status of the subscription.

  • Name
    subscriptionItems
    Type
    CommerceSubscriptionItemResource[]
    Description

    The list of items (plans/features) included in this subscription.

  • Name
    updatedAt
    Type
    Date | null
    Description

    The date when the subscription was last updated, or null if it hasn't been updated.

Feedback

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

Last updated on