GET
/
projects
/
{projectId}
/
stripe
/
subscription
curl --request GET \
  --url https://api.chat-dash.com/v1/public/projects/{projectId}/stripe/subscription \
  --header 'Authorization: <authorization>'
{
  "name": "<string>",
  "description": "<string>",
  "created": "<string>",
  "productId": "<string>",
  "priceIds": [
    "<string>"
  ],
  "currency": "<string>",
  "period": "<string>",
  "basePrice": "<string>",
  "unitAmount": "<string>",
  "overageLimitUnitAmount": "<string>",
  "usageLimitUnitAmount": "<string>",
  "usageLimit": "<string>",
  "overage": "<string>",
  "subscriptionCount": 123,
  "pricingModel": "<string>",
  "metrics": "<string>",
  "totalUsage": 123,
  "current_period_end": "<string>",
  "current_period_start": "<string>",
  "totalPrice": "<string>"
}

Headers

Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Path Parameters

projectId
string
required

The ID of the project

Response

200
application/json
OK
name
string

The name of the subscription

description
string

The description of the subscription

created
string

The date the subscription was created

productId
string

The ID of the product associated with the subscription

priceIds
string[]

The IDs of the prices associated with the subscription

currency
string

The currency of the subscription

period
string

The billing period of the subscription

basePrice
string

The base price of the subscription

unitAmount
string

The unit amount of the subscription

overageLimitUnitAmount
string

The overage limit unit amount of the subscription

usageLimitUnitAmount
string

The usage limit unit amount of the subscription

usageLimit
string

The usage limit of the subscription

overage
string

The overage of the subscription

subscriptionCount
number

The number of subscriptions

pricingModel
string

The pricing model of the subscription

metrics
string

The type of metrics used for the subscription

totalUsage
number

The total usage of the subscription

current_period_end
string

The end date of the current billing period

current_period_start
string

The start date of the current billing period

totalPrice
string

The total price of the subscription