Skip to main content
GET
/
stripe
/
connect
/
accounts
/
{accountId}
/
coupons
/
{couponId}
Get Coupon
curl --request GET \
  --url https://api.chat-dash.com/v1/public/stripe/connect/accounts/{accountId}/coupons/{couponId} \
  --header 'Authorization: <authorization>'
{
  "id": "SUMMER20",
  "object": "coupon",
  "amount_off": null,
  "created": 1700000000,
  "currency": null,
  "duration": "once",
  "duration_in_months": null,
  "livemode": true,
  "max_redemptions": null,
  "metadata": {},
  "name": "Summer Sale",
  "percent_off": 25,
  "redeem_by": null,
  "times_redeemed": 0,
  "valid": true
}

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

​
couponId
string
required

The Stripe coupon ID

Response

OK

​
id
string

The coupon ID

Example:

"SUMMER20"

​
object
string
Example:

"coupon"

​
amount_off
integer | null
Example:

null

​
created
integer
Example:

1700000000

​
currency
string | null
Example:

null

​
duration
enum<string>
Available options:
once,
repeating,
forever
Example:

"once"

​
duration_in_months
integer | null
Example:

null

​
livemode
boolean
Example:

true

​
max_redemptions
integer | null
Example:

null

​
metadata
object
Example:
{}
​
name
string
Example:

"Summer Sale"

​
percent_off
number | null
Example:

25

​
redeem_by
integer | null
Example:

null

​
times_redeemed
integer
Example:

0

​
valid
boolean
Example:

true