Skip to main content
GET
/
stripe
/
connect
/
accounts
/
{accountId}
/
subscriptions
/
{subscriptionId}
Get Subscription
curl --request GET \
  --url https://api.chat-dash.com/v1/public/stripe/connect/accounts/{accountId}/subscriptions/{subscriptionId} \
  --header 'Authorization: <authorization>'
{
  "id": "sub_1ABC123DEF456GHI",
  "type": "subscription",
  "status": "active",
  "cancelAtPeriodEndDisplay": "<string>",
  "customer": "cus_ABC123XYZ",
  "current_period_start": 1700000000,
  "current_period_end": 1702600000,
  "created": 1700000000,
  "collection_method": "charge_automatically",
  "cancel_at_period_end": false,
  "canceled_at": 123,
  "product": {
    "id": "prod_ABC123XYZ",
    "name": "Pro Plan"
  },
  "automatic_tax": false,
  "coupon": "",
  "agents": "Agent 1, Agent 2",
  "pricing": {
    "amount": "2999",
    "billingCycle": "month",
    "currency": "usd",
    "pricingModel": "base",
    "metrics": "minutes",
    "usageLimit": 100,
    "overage": "15"
  },
  "totalPrice": 2999,
  "totalUsage": 45.5
}

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

​
accountId
string
required

The Stripe connected account ID

​
subscriptionId
string
required

The Stripe subscription ID

Response

OK

​
id
string
Example:

"sub_1ABC123DEF456GHI"

​
type
string
Example:

"subscription"

​
status
string
Example:

"active"

​
cancelAtPeriodEndDisplay
string | null
​
customer
string
Example:

"cus_ABC123XYZ"

​
current_period_start
integer
Example:

1700000000

​
current_period_end
integer
Example:

1702600000

​
created
integer
Example:

1700000000

​
collection_method
string
Example:

"charge_automatically"

​
cancel_at_period_end
boolean
Example:

false

​
canceled_at
integer | null
​
product
object
​
automatic_tax
boolean
Example:

false

​
coupon
string
Example:

""

​
agents
string
Example:

"Agent 1, Agent 2"

​
pricing
object
​
totalPrice
integer

Total price the client will be charged (base price plus usage charges) in the smallest currency unit

Example:

2999

​
totalUsage
number
Example:

45.5