API Reference

Subscription

Plan and subscription management.

5 endpoints· Auth: API Key
get/api/v1/store/integrations/subscription API Key

Get subscription

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/subscription" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com
Set credentials in the “Authorize” menu
get/api/v1/store/integrations/subscription/plans API Key

Get plans

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/subscription/plans" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com
Set credentials in the “Authorize” menu
post/api/v1/store/integrations/subscription/upgrade-requests API Key

Create upgrade-requests

Request body

application/json
{
  "planId": "00000000-0000-0000-0000-000000000000",
  "planCode": "string",
  "returnUrl": "string",
  "browserInfo": {
    "browserAcceptHeader": "string",
    "browserIp": "string",
    "browserJavaEnabled": false,
    "browserLanguage": "string",
    "browserUserAgent": "string"
  }
}
planId
string (uuid)
—
planCode
string
—
returnUrl
string
—
browserInfo
QiCardBrowserInfo
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/subscription/upgrade-requests" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "planId": "00000000-0000-0000-0000-000000000000",
  "planCode": "string",
  "returnUrl": "string",
  "browserInfo": {
    "browserAcceptHeader": "string",
    "browserIp": "string",
    "browserJavaEnabled": false,
    "browserLanguage": "string",
    "browserUserAgent": "string"
  }
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Request body (JSON)

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/subscription/upgrade-requests/{requestId} API Key

Get requestId

Path parameters

requestIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/subscription/upgrade-requests/{requestId}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/subscription/upgrade-requests/{requestId}/verify API Key

Create verify

Path parameters

requestIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/subscription/upgrade-requests/{requestId}/verify" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu