Skip to main content
View as Markdown

The Subscription object

The Subscription object.

note

16 of 16 fields on this object have no description yet. Field documentation lives in the SDK types (types/subscription.ts) so it stays in one place — this page is generated from it.

Fields​

FieldTypeDescription
subscriptionId
REQUIRED		string
merchantId
REQUIRED		string
customerId
REQUIRED		string
customerEmail
REQUIRED		string
planId
REQUIRED		string
status
REQUIRED		SubscriptionStatusSee SubscriptionStatus. SubscriptionStatus
collectionMethod
REQUIRED		CollectionMethodSee CollectionMethod. CollectionMethod
storedPaymentMethodId
OPTIONAL		string
tspProvider
OPTIONAL		string
currentPeriodStart
REQUIRED		string
currentPeriodEnd
REQUIRED		string
nextBillingAt
REQUIRED		string
trialEnd
OPTIONAL		string
cancelAtPeriodEnd
REQUIRED		boolean
cancelledAt
OPTIONAL		string
pausedAt
OPTIONAL		string

Example​

{
  "subscriptionId": "subscription_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "customerId": "customer_1a2b3c",
  "customerEmail": "customer@example.com",
  "planId": "plan_1a2b3c",
  "status": "trialing",
  "collectionMethod": "auto_charge",
  "storedPaymentMethodId": "storedpaymentmethod_1a2b3c",
  "currentPeriodStart": "string",
  "currentPeriodEnd": "string",
  "nextBillingAt": "2026-01-15T09:30:00Z",
  "cancelAtPeriodEnd": false
}