Skip to main content

Internal subscription object with comprehensive billing and administrative details

ā€‹
_id
string

Unique identifier for the subscription.

ā€‹
orderIndex
integer

Order index of the subscription.

ā€‹
organizationId
string

Unique identifier for the organization associated with the subscription.

ā€‹
productId
string

Unique identifier for the product associated with the subscription. This is ID of Product Stripe see this link for full documentation https://stripe.com/docs/api/products/object

ā€‹
planName
string

Name of the subscription plan.

ā€‹
items
object[]

List of subscription items.

ā€‹
curPeriodStartTime
string

Start time of the current subscription period.

ā€‹
curPeriodEndTime
string

End time of the current subscription period.

ā€‹
status
enum<string>

Status of the subscription. Can be one of the following values: active (The subscription is currently active), inactive (The subscription is currently inactive), or unpaid (The subscription is unpaid, and payment is pending).

Available options:
active,
inactive,
unpaid
ā€‹
nextState
enum<string>

Next state of the subscription. Can be one of the following values: active (The subscription will become active) or inactive (The subscription will become inactive).

Available options:
active,
inactive
ā€‹
isDeleted
boolean

Flag indicating whether the subscription is deleted.

ā€‹
updatedTime
string

Timestamp of the last update to the subscription.

ā€‹
createdTime
string

Timestamp of when the subscription was created.

ā€‹
failedCode
enum<string>

Subscription Module business failedCode that indicate specific failure conditions or business rule violations during subscription module operations. These codes help identify the failed operation of subscription-related and provide standardized failure identification across the system.

Possible values:

  • subs-031: Duplicate entry - Subscription already exists
  • subs-033: Subscription not found - Please verify your subscription ID
  • subs-035: Access forbidden - User lacks billing permission
  • subs-040: Subscription limit exceeded - Subscription limit reached
  • subs-045: Server error - Internal server failure
Available options:
subs-031,
subs-033,
subs-035,
subs-040,
subs-045