📘 Name Type Description Required id string StripeSubscriptionID yes
Field Type Description id string Subscription ID stripeCustomerId string Stripe customer ID customerEmail string Customer email status string Subscription status currentPeriodStart string Current period start (ISO 8601) currentPeriodEnd string Current period end (ISO 8601) plan object Subscription plan details subscriptionPricing object Subscription pricing with fees breakdown (optional) invoices array Associated invoices array (optional)
Field Type Description stripePriceId string Stripe price ID name string Plan display name amount number Price amount in cents currency string Currency code (e.g., "usd") interval string Billing frequency unit (day, week, month, year) intervalCount number Frequency multiplier
Field Type Description id number Invoice ID status string Invoice status grossPremium number Gross premium amount commission number Commission amount netPremium number Net premium amount serviceFee number Service fee policyId string Policy ID (nullable) effectiveDate string Effective date (ISO 8601) expirationDate string Expiration date (ISO 8601) createdAt string Invoice creation date (ISO 8601)
JSON
{
"id": "sub_ExampleSubscription789",
"stripeCustomerId": "cus_ExampleCustomerID123",
"customerEmail": "[email protected] ",
"status": "active",
"currentPeriodStart": "2024-01-01T00:00:00.000Z",
"currentPeriodEnd": "2024-02-01T00:00:00.000Z",
"plan": {
"stripePriceId": "price_ExamplePriceID456",
"name": "Premium Auto Insurance",
"amount": 4999,
"currency": "usd",
"interval": "month",
"intervalCount": 1
},
"invoices": [
{
"id": 98765,
"status": "paid",
"grossPremium": 49.99,
"commission": 5.0,
"netPremium": 44.99,
"serviceFee": 2.5,
"policyId": "POL-2024-001",
"effectiveDate": "2024-01-01T00:00:00.000Z",
"expirationDate": "2024-02-01T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z"
}
]
}This endpoint retrieves detailed information about a specific subscription. Use this to check subscription status, view billing details, or get information about the associated customer and plan. The response includes comprehensive details about the subscription's current state, billing schedule, and associated invoices.
