Get Started
Language
Video
Audio
Get User Subscription Info
Gets all information about the users active subscription.
curl --request GET \
--url https://api.deepreel.com/subscription/active/ \
--header 'X-API-KEY: <api-key>'
{
"subscription": {
"plan": {
"name": "<string>",
"mode": "month",
"usage_based_allowed": true
},
"plan_expires_at": "2023-11-07T05:31:56Z",
"total_credits": 123,
"credits_used": 123,
"extra_credits_charges": 123,
"total_custom_avatar_credits": 123,
"custom_avatar_credits_left": 123,
"scheduled_subscription": {
"plan": "<string>",
"mode": "month",
"start_date": "2023-11-07T05:31:56Z"
}
}
}
Authorizations
Your API key with the prefix: dr_
. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the account settings panel (In the bottom left corner click on your Account
→ profile
)
Response
Current subscription plan.
DateTime when current subscription plan will expire.
Total credits available in current subscription plan (Monthly or Annually).
Credits used in current subscription plan (Monthly or Annually).
Charges to consume overage credits on current subscription plan.
Total custom avatar credits available in current subscription plan (Monthly or Annually).
Custom avatar credits used in current subscription plan (Monthly or Annually).
Scheduled subscription plan.
Name of the plan.
Mode of the plan.
month
- monthyear
- year
month
, year
DateTime when this plan will be activated.
curl --request GET \
--url https://api.deepreel.com/subscription/active/ \
--header 'X-API-KEY: <api-key>'
{
"subscription": {
"plan": {
"name": "<string>",
"mode": "month",
"usage_based_allowed": true
},
"plan_expires_at": "2023-11-07T05:31:56Z",
"total_credits": 123,
"credits_used": 123,
"extra_credits_charges": 123,
"total_custom_avatar_credits": 123,
"custom_avatar_credits_left": 123,
"scheduled_subscription": {
"plan": "<string>",
"mode": "month",
"start_date": "2023-11-07T05:31:56Z"
}
}
}