Skip to main content

StripeSubscription

A native Stripe Subscription object (passed through unmodified). Only the fields LDS reads (StripeSubscription in lib/platform/client.ts) are documented.

idstring

Stripe subscription id.

Example: sub_1NXYZabcDEF
objectstring
Constant value: subscription
statusstring | nullnullable

Stripe subscription status.

Possible values: [active, past_due, unpaid, canceled, incomplete, incomplete_expired, trialing, paused, null]

customerIdstring | nullnullable

Customer id. (Stripe's native field is customer; the LDS client reads customerId.)

metadata object
organization_idstring
property name*string
property name*any

A native Stripe Subscription object (passed through unmodified). Only the fields LDS reads (StripeSubscription in lib/platform/client.ts) are documented.

StripeSubscription
{
"id": "sub_1NXYZabcDEF",
"object": "subscription",
"status": "active",
"customerId": "string",
"metadata": {
"organization_id": "string"
}
}