Skip to main content

​
Primary key

document_id
uuiddefault:"Random UUID"publicrequired
The unique identifier for the subscription product record.

​
Specific attributes

date_subscribed
timestamppublicrequired
The date and time when the product was subscribed to.
Rules: Precision: 6, with timezone
date_unsubscribed
timestamppublic
The date and time when the product was unsubscribed from, if applicable.
Rules: Precision: 6, with timezone

​
Foreign keys

billing_cycle
uuidpublicrequired
The unique identifier of the associated billing cycle. Ref: BillingCycle Schema
product_price_version
uuidpublicrequired
The unique identifier of the associated product price version. Ref: ProductPriceVersion Schema
subscription
uuidpublicrequired
The unique identifier of the associated subscription. Ref: Subscription Schema

​
Tracking attributes

created_at
timestamppublic
The timestamp when the subscription product record was created.
Rules: Precision: 6, with timezone
deleted_at
timestamppublic
The timestamp when the subscription product record was deleted, if applicable.
Rules: Precision: 6, with timezone
is_actived
booleandefault:"true"public
Indicates whether the subscription product record is active.
is_deleted
booleandefault:"false"public
Indicates whether the subscription product record has been deleted.
updated_at
timestamppublic
The timestamp when the subscription product record was last updated.
Rules: Precision: 6, with timezone