Catalogs
Get Catalog
Catalogs
Get Catalog
GET
/
api
/
v1
/
catalogs
/
{id}
curl --request GET \
--url https://app.flowglad.com/api/v1/catalogs/{id} \
--header 'Authorization: <api-key>'{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"livemode": true,
"organizationId": "<string>",
"isDefault": true,
"name": "<string>",
"products": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"displayFeatures": [
{
"enabled": true,
"label": "<string>",
"details": "<string>"
}
],
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"catalogId": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD"
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD"
}
}
]
}Authorizations
Path Parameters
Response
200
application/json
Successful response
safeZodDate
safeZodDate
safeZodDate
safeZodDate
A subscription price, which will have details on the interval, default trial period, and setup fee (if any).
Available options:
day, week, month, year safeZodPositiveInteger
Available options:
subscription safeZodPositiveInteger
safeZodPositiveInteger
safeZodPositiveInteger
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW The default price for the product. If no price is explicitly set as default, will return the first price created for the product..
Available options:
day, week, month, year safeZodPositiveInteger
Available options:
subscription safeZodPositiveInteger
safeZodPositiveInteger
safeZodPositiveInteger
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW curl --request GET \
--url https://app.flowglad.com/api/v1/catalogs/{id} \
--header 'Authorization: <api-key>'{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"livemode": true,
"organizationId": "<string>",
"isDefault": true,
"name": "<string>",
"products": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"displayFeatures": [
{
"enabled": true,
"label": "<string>",
"details": "<string>"
}
],
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"catalogId": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD"
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD"
}
}
]
}