Qodex.ai
Qodex.ai
Introduction
Crisp REST API Reference (V1)
Website-Base
Get A WebsiteDelete A WebsiteCreate WebsiteAbort Website DeletionCheck If Website Exists
Website-Conversations
Delete Suggested Conversation SegmentList Suggested Conversation Data KeysSubmit Spam Conversation DecisionResolve Spam Conversation ContentList Spam ConversationsList Suggested Conversation SegmentsDelete Suggested Conversation Data Key⭐ List Conversations
Website-Conversation
Initiate A Conversation With Existing SessionDeliver Widget Button Action For ConversationRequest Email Transcript For ConversationList Conversation FilesGet Verify Status For Conversation⭐ Get Conversation Metas⭐ Change Conversation StateRequest Chatbox Binding Purge For ConversationRemove A Conversation⭐ Send A Message In ConversationSave Conversation ParticipantsRemove A Message In ConversationList Browsing Sessions For ConversationUpdate Conversation Open StateAssist An Existing Browsing Session⭐ Get Messages In ConversationSend Action To An Existing Browsing SessionCompose A Message In ConversationGet Block Status For Conversation⭐ Update Conversation MetasGet Conversation State⭐ Mark Messages As Read In ConversationRequest User Feedback For ConversationCheck If Conversation ExistsUpdate Verify Status For ConversationGet Conversation Participants⭐ Mark Messages As Delivered In Conversation⭐ Assign Conversation RoutingUpdate Conversation InboxBlock Incoming Messages For ConversationList Conversation Events⭐ Get A ConversationDeliver Widget Data Action For Conversation⭐ Get Conversation Routing AssignGet A Message In ConversationGet An Original Message In Conversation⭐ Create A New ConversationGet Ongoing Call Session For ConversationInitiate New Call Session For ConversationAbort Ongoing Call Session For ConversationUpdate A Message In ConversationInitiate Browsing Session For ConversationList Conversation PagesTransmit Signaling On Ongoing Call SessionSchedule A Reminder For Conversation
Website-People
List People ConversationsList Suggested People EventsImport People Profiles⭐ Check If People Profile ExistsAdd A People Event⭐ Save People ProfileGet People Data⭐ Get People ProfileList Suggested People Data Keys⭐ List People Profiles⭐ Update People ProfileDelete Suggested People SegmentList People EventsDelete Suggested People EventUpdate People Subscription Status⭐ Remove People ProfileExport People ProfilesList Suggested People Segments⭐ Add New People ProfileDelete Suggested People Data KeyGet People Subscription StatusSave People DataList People CampaignsUpdate People DataGet People Statistics
Website-Visitors
Pinpoint Visitors On A MapList VisitorsClear Blocked Visitors In RuleCount VisitorsCount Blocked Visitors In RuleCount Blocked VisitorsGet Session Identifier From Token
Website-Availability
List Website Operator AvailabilitiesGet Website Availability Status
Website-Operators
List Last Active Website OperatorsFlush Last Active Website OperatorsSend Email To Website OperatorsList Website Operators
Website-Operator
Get A Website OperatorInvite A Website OperatorUnlink Operator From WebsiteChange Operator Membership
Website-Helpdesk
Resolve Helpdesk Locale ArticleList Helpdesk LocalesResolve Helpdesk Locale Article CategoryResolve HelpdeskSave Helpdesk Locale SectionCheck If Helpdesk Locale ExistsDelete Helpdesk RedirectionAdd Helpdesk LocaleResolve Helpdesk LocaleUnpublish Helpdesk Locale ArticleUpdate Helpdesk Locale SectionList Helpdesk Locale Article AlternatesUpdate Helpdesk Locale Article CategoryCheck If Helpdesk Locale Article Alternate ExistsList Helpdesk Locale CategoriesResolve Helpdesk Locale Article PageUpdate Helpdesk Locale CategoryResolve Helpdesk DomainDelete Helpdesk Locale Article AlternateDelete Helpdesk Locale ArticleMap Helpdesk Locale Feedback RatingsDelete Helpdesk Locale SectionDelete Helpdesk LocaleList Helpdesk Locale SectionsResolve Helpdesk Locale SectionAdd Helpdesk Locale SectionCheck If Helpdesk ExistsSave Helpdesk Locale CategorySave Helpdesk SettingsList Helpdesk Locale FeedbacksSave Helpdesk Locale ArticleAdd Helpdesk RedirectionRequest Helpdesk Domain ChangeResolve Helpdesk Locale Article AlternatePublish Helpdesk Locale ArticleSave Helpdesk Locale Article AlternateCheck If Helpdesk Redirection ExistsResolve Helpdesk SettingsList Helpdesk Locale ArticlesInitialize HelpdeskGenerate Helpdesk Domain Setup FlowResolve Helpdesk Locale CategoryList Helpdesk RedirectionsDelete Helpdesk Locale CategoryAdd Helpdesk Locale CategoryCheck If Helpdesk Locale Section ExistsDelete HelpdeskAdd A New Helpdesk Locale ArticleUpdate Helpdesk Locale ArticleCheck If Helpdesk Locale Article ExistsCheck If Helpdesk Locale Category ExistsResolve Helpdesk RedirectionImport External Helpdesk To LocaleExport Helpdesk Locale Articles
Website-Campaigns
Save A Campaign TemplateCheck If Campaign Template ExistsGet A Campaign TemplateCreate A New Campaign TemplateUpdate A Campaign TemplateList Campaign TagsList Campaign TemplatesList CampaignsRemove A Campaign Template
Website-Campaign
Pause A CampaignList Campaign StatisticsRemove A CampaignCreate A New CampaignTest A CampaignResume A CampaignCheck If Campaign ExistsSave A CampaignList Campaign RecipientsDispatch A CampaignGet A CampaignUpdate A Campaign
Website-Analytics
Generate Analytics
Website-Batch
Batch Resolve ItemsBatch Read ItemsBatch Remove Items
Website-Settings
Get Website SettingsUpdate Website Settings
Website-Verify
Get Verify SettingsGet Verify KeyUpdate Verify SettingsRoll Verify Key
Plugin-Subscription
Get Subscription DetailsReport Plugin Usage To BillUpdate Subscription SettingsGet Subscription SettingsSubscribe Website To PluginDispatch Plugin EventList All Active SubscriptionsForward Plugin Payload To ChannelGet Plugin Usage BillsList Subscriptions For A WebsiteUnsubscribe Plugin From WebsiteSave Subscription Settings
Plugin-Connect Account
⭐ Get Connect Account
Plugin-Connect Session
⭐ Check Connect Session Validity
Plugin-Connect Websites
List Connect Websites Since⭐ List All Connect Websites
Plugin-Connect Endpoints
⭐ Get Connect Endpoints
Bucket-URL
Generate Bucket URL
Media-Animation
List Animation Medias
Introduction
Crisp REST API Reference (V1)
Website-Base
Get A WebsiteDelete A WebsiteCreate WebsiteAbort Website DeletionCheck If Website Exists
Website-Conversations
Delete Suggested Conversation SegmentList Suggested Conversation Data KeysSubmit Spam Conversation DecisionResolve Spam Conversation ContentList Spam ConversationsList Suggested Conversation SegmentsDelete Suggested Conversation Data Key⭐ List Conversations
Website-Conversation
Initiate A Conversation With Existing SessionDeliver Widget Button Action For ConversationRequest Email Transcript For ConversationList Conversation FilesGet Verify Status For Conversation⭐ Get Conversation Metas⭐ Change Conversation StateRequest Chatbox Binding Purge For ConversationRemove A Conversation⭐ Send A Message In ConversationSave Conversation ParticipantsRemove A Message In ConversationList Browsing Sessions For ConversationUpdate Conversation Open StateAssist An Existing Browsing Session⭐ Get Messages In ConversationSend Action To An Existing Browsing SessionCompose A Message In ConversationGet Block Status For Conversation⭐ Update Conversation MetasGet Conversation State⭐ Mark Messages As Read In ConversationRequest User Feedback For ConversationCheck If Conversation ExistsUpdate Verify Status For ConversationGet Conversation Participants⭐ Mark Messages As Delivered In Conversation⭐ Assign Conversation RoutingUpdate Conversation InboxBlock Incoming Messages For ConversationList Conversation Events⭐ Get A ConversationDeliver Widget Data Action For Conversation⭐ Get Conversation Routing AssignGet A Message In ConversationGet An Original Message In Conversation⭐ Create A New ConversationGet Ongoing Call Session For ConversationInitiate New Call Session For ConversationAbort Ongoing Call Session For ConversationUpdate A Message In ConversationInitiate Browsing Session For ConversationList Conversation PagesTransmit Signaling On Ongoing Call SessionSchedule A Reminder For Conversation
Website-People
List People ConversationsList Suggested People EventsImport People Profiles⭐ Check If People Profile ExistsAdd A People Event⭐ Save People ProfileGet People Data⭐ Get People ProfileList Suggested People Data Keys⭐ List People Profiles⭐ Update People ProfileDelete Suggested People SegmentList People EventsDelete Suggested People EventUpdate People Subscription Status⭐ Remove People ProfileExport People ProfilesList Suggested People Segments⭐ Add New People ProfileDelete Suggested People Data KeyGet People Subscription StatusSave People DataList People CampaignsUpdate People DataGet People Statistics
Website-Visitors
Pinpoint Visitors On A MapList VisitorsClear Blocked Visitors In RuleCount VisitorsCount Blocked Visitors In RuleCount Blocked VisitorsGet Session Identifier From Token
Website-Availability
List Website Operator AvailabilitiesGet Website Availability Status
Website-Operators
List Last Active Website OperatorsFlush Last Active Website OperatorsSend Email To Website OperatorsList Website Operators
Website-Operator
Get A Website OperatorInvite A Website OperatorUnlink Operator From WebsiteChange Operator Membership
Website-Helpdesk
Resolve Helpdesk Locale ArticleList Helpdesk LocalesResolve Helpdesk Locale Article CategoryResolve HelpdeskSave Helpdesk Locale SectionCheck If Helpdesk Locale ExistsDelete Helpdesk RedirectionAdd Helpdesk LocaleResolve Helpdesk LocaleUnpublish Helpdesk Locale ArticleUpdate Helpdesk Locale SectionList Helpdesk Locale Article AlternatesUpdate Helpdesk Locale Article CategoryCheck If Helpdesk Locale Article Alternate ExistsList Helpdesk Locale CategoriesResolve Helpdesk Locale Article PageUpdate Helpdesk Locale CategoryResolve Helpdesk DomainDelete Helpdesk Locale Article AlternateDelete Helpdesk Locale ArticleMap Helpdesk Locale Feedback RatingsDelete Helpdesk Locale SectionDelete Helpdesk LocaleList Helpdesk Locale SectionsResolve Helpdesk Locale SectionAdd Helpdesk Locale SectionCheck If Helpdesk ExistsSave Helpdesk Locale CategorySave Helpdesk SettingsList Helpdesk Locale FeedbacksSave Helpdesk Locale ArticleAdd Helpdesk RedirectionRequest Helpdesk Domain ChangeResolve Helpdesk Locale Article AlternatePublish Helpdesk Locale ArticleSave Helpdesk Locale Article AlternateCheck If Helpdesk Redirection ExistsResolve Helpdesk SettingsList Helpdesk Locale ArticlesInitialize HelpdeskGenerate Helpdesk Domain Setup FlowResolve Helpdesk Locale CategoryList Helpdesk RedirectionsDelete Helpdesk Locale CategoryAdd Helpdesk Locale CategoryCheck If Helpdesk Locale Section ExistsDelete HelpdeskAdd A New Helpdesk Locale ArticleUpdate Helpdesk Locale ArticleCheck If Helpdesk Locale Article ExistsCheck If Helpdesk Locale Category ExistsResolve Helpdesk RedirectionImport External Helpdesk To LocaleExport Helpdesk Locale Articles
Website-Campaigns
Save A Campaign TemplateCheck If Campaign Template ExistsGet A Campaign TemplateCreate A New Campaign TemplateUpdate A Campaign TemplateList Campaign TagsList Campaign TemplatesList CampaignsRemove A Campaign Template
Website-Campaign
Pause A CampaignList Campaign StatisticsRemove A CampaignCreate A New CampaignTest A CampaignResume A CampaignCheck If Campaign ExistsSave A CampaignList Campaign RecipientsDispatch A CampaignGet A CampaignUpdate A Campaign
Website-Analytics
Generate Analytics
Website-Batch
Batch Resolve ItemsBatch Read ItemsBatch Remove Items
Website-Settings
Get Website SettingsUpdate Website Settings
Website-Verify
Get Verify SettingsGet Verify KeyUpdate Verify SettingsRoll Verify Key
Plugin-Subscription
Get Subscription DetailsReport Plugin Usage To BillUpdate Subscription SettingsGet Subscription SettingsSubscribe Website To PluginDispatch Plugin EventList All Active SubscriptionsForward Plugin Payload To ChannelGet Plugin Usage BillsList Subscriptions For A WebsiteUnsubscribe Plugin From WebsiteSave Subscription Settings
Plugin-Connect Account
⭐ Get Connect Account
Plugin-Connect Session
⭐ Check Connect Session Validity
Plugin-Connect Websites
List Connect Websites Since⭐ List All Connect Websites
Plugin-Connect Endpoints
⭐ Get Connect Endpoints
Bucket-URL
Generate Bucket URL
Media-Animation
List Animation Medias
HomeCrisp REST API Reference (V1)Plugin-SubscriptionReport Plugin Usage To Bill

Report Plugin Usage To Bill

POST https://api.crisp.chat/v1/plugins/subscription/:website_id/:plugin_id/bill/usage

Request Body

{"name"=>"Paid messages sent", "units"=>250, "price"=>0.1}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
X-Crisp-Tierstring
Previous
Get Subscription Details
Next
Update Subscription Settings