Get subscription products

📘
API Refs

Staging: Get subscription products

Query Parameters

Name	Type	Description	Required
include_plans	boolean	Whether to include pricing plans in the response	no

Response body

Success Response (200 OK)

Returns an array of product objects.

Product Object

Field	Type	Description
stripeProductId	string	Stripe product identifier
name	string	Product name
description	string	Product description
plans	array	Available pricing plans (only if include_plans=true)

Plan Object (when included)

Field	Type	Description
stripePriceId	string	Stripe price ID
amount	number	Price amount in cents
currency	string	Currency code
interval	string	Billing interval

Response

[
  {
    "stripeProductId": "prod_ExampleProductABC",
    "name": "Auto Insurance Plans",
    "description": "Comprehensive auto insurance coverage with multiple plan options",
    "plans": [
      {
        "stripePriceId": "price_ExamplePriceID456",
        "amount": 4999,
        "currency": "usd",
        "interval": "month"
      },
      {
        "stripePriceId": "price_ExamplePriceID789",
        "amount": 49999,
        "currency": "usd",
        "interval": "year"
      }
    ]
  },
  {
    "stripeProductId": "prod_ExampleProductDEF",
    "name": "Home Insurance Plans",
    "description": "Complete home insurance protection",
    "plans": [
      {
        "stripePriceId": "price_ExamplePriceID321",
        "amount": 7999,
        "currency": "usd",
        "interval": "month"
      }
    ]
  }
]

Description

This endpoint retrieves all subscription products for the merchant. Products represent what you're selling (e.g., different insurance coverage tiers), and optionally include the associated pricing plans that define billing intervals and amounts.

Use this endpoint to:

Display available subscription options to your customers
Get product and price IDs for creating subscriptions
Manage your product catalog

Error Responses

401 Unauthorized: Invalid or missing authorization token
403 Forbidden: Insufficient permissions