Skip to main content

StripeSubscriptionList

Native Stripe list object returned by GET /stripe/subscriptions.

objectstring
Constant value: list
has_moreboolean
data object[]
  • Array [
  • 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.

  • ]
  • property name*any

    Native Stripe list object returned by GET /stripe/subscriptions.

    StripeSubscriptionList
    {
    "object": "list",
    "has_more": true,
    "data": [
    {
    "id": "sub_1NXYZabcDEF",
    "object": "subscription",
    "status": "active",
    "customerId": "string",
    "metadata": {
    "organization_id": "string"
    }
    }
    ]
    }