Skip to content
API Reference/
/
service_orgs_users_stripe...

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

service_orgs_users_stripe_checkout_session_create

Request

Stripe checkout session API View for user upgrade

Request the following fields:

  • tenant
  • sku
  • mode
  • success_url
  • cancel_url

Response: { "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx", }

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
skustring

Product SKU

productstring

Alternative to SKU

tenantstringrequired

Tenant type to create after successful checkout

success_urlstring(uri)required

URL to redirect after successful payment

cancel_urlstring(uri)required

URL to redirect if checkout cancelled

modestring
Default "subscription"
Enum"subscription""payment""setup"
periodstring
Enum"weekly""monthly""yearly"
meteredboolean

Whether to use metered billing

Default false
quantityinteger>= 1

Subscription quantity

Default 1
couponstring

Coupon code to apply

is_free_trialboolean

Enable free trial

Default false
trial_daysinteger>= 1

Trial period in days

skip_cardboolean

Skip card collection for trial

Default false
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/service/orgs/{org}/users/{user_id}/stripe/checkout-session/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "string",
    "product": "string",
    "tenant": "string",
    "success_url": "http://example.com",
    "cancel_url": "http://example.com",
    "mode": "subscription",
    "period": "weekly",
    "metered": false,
    "quantity": 1,
    "coupon": "string",
    "is_free_trial": false,
    "trial_days": 1,
    "skip_card": false
  }'

Responses

Bodyapplication/json
redirect_tostring(uri)required
Response
application/json
{
  "redirect_to": "http://example.com"
}

service_orgs_users_stripe_customer_portal_create

Request

Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
return_urlstring(uri)required

URL to redirect to when the back button is clicked

subscription_idstring

Provide a subscription id to set the default landing page to subscription update

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/service/orgs/{org}/users/{user_id}/stripe/customer-portal/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "return_url": "http://example.com",
    "subscription_id": "string"
  }'

Responses

Bodyapplication/json
urlstring(uri)required
Response
application/json
{
  "url": "http://example.com"
}

service_orgs_users_stripe_products_retrieve

Request

Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/service/orgs/{org}/users/{user_id}/stripe/products/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
namestring<= 255 charactersrequired
descriptionstring or null
pricestringread-onlyrequired
stripe_product_idstring or null<= 250 characters
skustring<= 255 charactersrequired
platformstringread-onlyrequired
Response
application/json
{
  "name": "string",
  "description": "string",
  "price": "string",
  "stripe_product_id": "string",
  "sku": "string",
  "platform": "string"
}

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com