Placewise API
Performance Cloud
Placewise
  1. History
  • Overview
    • Introduction
    • Hosts
    • Global Headers
    • Common HTTP Error Codes
    • API Permits
    • Authorization
      • Token Authorization
      • Member Authorization
      • User Authorization
    • API Contexts
      • Customer Context
      • LoyaltyClub Context
      • Global Context
    • Common Concepts
      • Localization
      • System URLs
      • Params Validation
      • Pagination
      • Sorting
    • Common Models
      • Common Data Formats
      • Member Model
      • API Entity Model
      • Opening Hours Model
  • Reference
    • API Structure
    • Public API
      • Introduction
      • Loyalty Club
        • Loyalty Clubs
          • Introduction
          • Show Loyalty Club
          • List Loyalty Clubs
        • Schema
          • Show Schema
        • Legal Information
          • Show Legal Information
        • Translations
          • List Translations (v4)
          • List Translations (v3)
        • Carbon Offset Program
          • Show Carbon Offset Program Info
        • Cars
          • Show Cars Configuration
          • Show Available Cars Colors
        • Programs
          • Introduction
          • List Programs
          • Show Program
        • Receipts
          • Introduction
          • Show Receipts Configuration
      • Member
        • Authentication
          • OAuth Flow
          • One Time Password
            • Send OTP via SMS
            • Send OTP via SMS by Email
            • Send OTP via Email
            • Send OTP via Email by MSISDN
          • Registration Password
            • Send Registration Password SMS
            • Send Registration Password Email
          • Create Token
          • Revoke Token
          • Show Token Info
        • Central Authentication
          • Social Logins
            • Create Social Login
            • Create Social Login
          • Passwords
            • set
        • Profile
          • Public Info
            • Show Member Public Info
            • Show Member Public Info by MSISDN
            • Show Member Public Info by Email
          • Person ID
            • Show Member Person ID
            • Show Member Person ID by MSISDN
            • Show Member Person ID by Email
          • Create Member
          • Update Member
          • Validate Member
          • Register Member App Token
          • Show Member
          • Destroy Member
        • Programs
          • Registration
            • Start
            • Confirm
          • Update Member Programs
          • Add Member to Program
          • List Member Programs
          • Remove Member from Program
        • Cars
          • Introduction
          • List Member Cars
          • Create Member Car
          • Show Member Car
          • Update Member Car
          • Renew Member Car
          • Destroy Member Car
          • Lookup a Car
        • Benefits
          • Introduction
          • List Member Benefits
          • Show Member Benefit
        • Verification
          • Send Verification Email
          • Send Verification SMS
          • Verify Email
          • Verify MSISDN
        • Password
          • Update Password
          • Reset Password
          • Send Password Reset Token
        • Integrations
          • Amano Parking Integration
            • Create Card
            • Delete Card
          • Spaycial Integrations
            • Generate Connections URL
            • Generate Connect URL
            • Show Spaycial Connections Status
            • Show Spaycial Feature Settings
            • Update Spaycial Feature Settings
        • Receipts
          • Introduction
          • List Submissions
          • Show Submission
          • Create Submission
          • Update Submission
          • Delete Submission
          • Check Limits Exceeded
        • Misc
          • Generate Link
          • Checkin to Store
        • Files
          • Uploads
            • Upload status
            • Start Upload
            • Upload Part
            • Finish Upload
            • Activate Uploaded File
      • Offers
        • Introduction
        • Offers
          • Show Offers Meta
          • Show Offer
          • Encode Offer
          • List Offers
          • Use Offer
          • Like Offer
          • Unlike Offer
        • Offers Preview
          • Preview Offers Meta
          • Preview Offer
          • Preview Offers List
        • Events
          • Introduction
          • Register "clicked" Event
          • Register "seen" Event
      • Rewards
        • Introduction
        • Rewards Program
          • Show Rewards Program
          • Join To Rewards Program
          • Leave Rewards Program
          • Show Member Rewards Program Status
          • Show Achievements Summary
        • Rewards
          • List Rewards
          • List Purchased Rewards
          • Purchase Reward
          • Use Reward
      • Games
        • Introduction
        • Games
          • List Games
          • Show Game Details
          • Show Game Ticket
          • Play Game
          • Issue Game Prize
      • CMS Content
        • Introduction
        • Website
          • Introduction
          • Show Website
        • Venue Info
          • Introduction
          • Show Venue Info
        • Components
          • Component Schema Model
          • Show Components Schema
        • Pages
          • Introduction
          • List Pages
          • Show Page
          • Route Page
        • Articles
          • Article Model
          • List Articles
          • Show Article
        • Events
          • Event Model
          • List Events
          • Show Event
        • Events Groups
          • Introduction
          • List Events Groups
          • Show Events Group
        • Job Postings
          • Introduction
          • List Job Postings
          • Show Job Posting
        • Service Messages
          • Introduction
          • List Service Messages
          • Show Service Message
        • Stores
          • Introduction
          • List
          • Show
        • Stores Categories
          • Introduction
          • List Stores Categories
          • Show Stores Category
        • Promotions
          • Introduction
          • List Promotions Collections
          • List Promotions
          • Show Promotion
        • Press Releases
          • Press Release Model
          • List Press Releases
          • Show Press Release
        • Attachments
          • Attachment Model
          • List Attachments
    • Management API
      • Introduction
      • Core
        • Applications
          • Application model
          • Branding
            • Show application branding
            • Update application branding
            • Destroy application branding
          • List applications
          • Create application
          • Update application
          • Show application
          • Destroy application
        • Privacy Policy
          • Introduction
          • Community
            • Community Model
            • Show Community
            • Update Community
          • Show Privacy Policy
          • Update Privacy Policy
        • Cookie Policy
          • Show Cookie Policy
          • Update Cookie Policy
        • Terms
          • Introduction
          • Show Terms
          • Update Terms
        • Domains
          • Introduction
          • List Domains
          • Show Domain
          • Create Domain
          • Destroy Domain
        • Domain Email Configs
          • Introduction
          • Show Domain Email Config
          • Create Domain Email Config
          • Destroy Domain Email Config
        • Domain Web Configs
          • Introduction
          • Show Domain Web Config
          • Create Domain Web Config
          • Destroy Domain Web Config
        • TLS Certificates
          • Introduction
          • List TLS Certificates
          • Show TLS Certificate
          • Create TLS Certificate
          • Update TLS Certificate
          • Destroy TLS Certificate
        • Links
          • Introduction
          • List Links
          • Show Link
          • Enable Link
          • Disable Link
          • Create Link
          • Delete Link
          • Generate Link
        • Fonts
          • Introduction
          • List Fonts
          • Show Font
          • Create Font
          • Enable Font
          • Disable Font
          • Update Font
          • Destroy Font
        • Subunits
          • Introduction
          • List Subunits
          • Show Subunit By External ID
          • Show Subunit
          • Create Subunit
          • Update Subunit
          • Destroy Subunit
        • Subunits Scopes
          • Introduction
          • List Subunits Scopes
          • Show Subunits Scope
          • Create Subunits Scope
          • Update Subunits Scope
          • Destroy Subunits Scope
        • SMS Sender Identities
          • Introduction
          • List Sms Sender Identities
        • Contacts
          • Introduction
          • List Customer Contacts
          • Show Customer Contact
          • Create Customer Contact
          • Update Customer Contact
          • Destroy Customer Contact
          • List Organization Contacts
          • Show Organization Contact
          • Create Organization Contact
          • Update Organization Contact
          • Destroy Organization Contact
        • Translations
          • Mobile App Translations
            • Show Mobile App Translations
            • Update Mobile App Translations
        • Promotions Policy
          • Introduction
          • Show Promotions Policy
          • Update Promotions Policy
        • Tracker
          • Show Loyalty Club Configuration
          • Update Loyalty Club Configuration
          • List tracked links
          • Show tracked link
        • Social Logins
          • List configurations
          • Show configuration
          • Create configuration
          • Update configuration
          • Destroy configuration
        • Billing
          • Service Quotas
            • ServiceQuotasConfig Model
            • List Service quotas configs
            • Create Service quotas config
            • Show Service quotas config
            • Update Service quotas config
            • Delete Service quotas config
          • Recurring Charges
            • RecurringCharge Model
            • Archieve Recurring charge
            • Restore Recurring charge
            • List Recurring charges
            • Create Recurring charge
            • Show Recurring charge
            • Update Recurring charge
            • Delete Recurring charge
          • Service Usages
            • History
              • Show Service Usage History
                GET
            • List Service Usages
              GET
          • Customer Accoutning Configurations
            • Show customer accoutning configuration
            • Update customer accoutning configuration
          • Show billing summary
            GET
          • Show billing breakdown
            GET
          • Show billing balance
            GET
          • Show billing manual balance changes
            GET
          • Add billing manual balance changes Copy
            POST
        • Member Authentication Configuration
          • Show loyalty club member authentication configuration
          • Show application member authentication configuration
          • Update member authentication configuration
          • Destroy member authentication configuration
      • Members
        • Listing Members
          • List Members
          • List Members By Audience
        • Member Profile
          • Public Info
            • Show Member Public Info
            • Show Member Public Info by MSISDN
            • Show Member Public Info by Email
          • Person ID
            • Show Member Person ID
            • Show Member Person ID by MSISDN
            • Show Member Person ID by Email
          • Cars
            • Introduction
            • List Member Cars
            • Create Member Cars
            • Show Member Car
            • Find Member Car By LPN
            • Update Member Car
            • Renew Member Car
            • Destroy Member Car
            • Lookup a Car
          • Children
            • MemberChild Model
            • List Member Children
            • Register Member Child
            • Show Member Child
            • Update Member Child
            • Unregister Member Child
          • Groups
            • Add Member to Group
            • Remove Member from a Group
            • List Members of a Group
            • List Groups of a Member By MSISDN
            • List Groups of a Member by Email
            • List Groups of a Member
            • Add Members to Group
            • Remove Members from Group
          • Programs
            • By Member Token
              • List Member Programs
              • Update Member Programs
              • Add Member to Program
              • Remove Member from Program
            • List Member Programs
            • Update Member Programs
            • Add Member to Program
            • Remove Member from Program
          • Benefits
            • Introduction
            • List Member Benefits
            • Show Member Benefit
            • Show Member Parking Benefit By Car LPN
          • Offers
            • Show Offers Meta
            • Show Offer
            • Encode Offer
            • List Offers
            • Use Offer
            • Like Offer
            • Unlike Offer
            • Grant Offer
          • Rewards
            • Show Member Rewards Status
            • Grant Points
            • Cancel Transaction
          • Export
            • Export Member
            • Download Member Export
          • Misc
            • Show Member Messages History
            • Show Member Profile History
          • Create Member
          • Update Member
          • Validate Member
          • Register Member App Token
          • Show Member
          • Show Member By MSISDN
          • Show Member By Email
          • Show Member By Encrypted ID
          • Show Member By User ID
          • Destroy Member
        • Imports
          • Introduction
          • Create Members Import Request
          • Show Members Import Status
          • Show Members Import Bulk Status By Request Number
          • Show Members Import Bulk Status
        • Groups
          • Introduction
          • Groups
            • List Member Groups
            • Show Member Group
            • Create Member Group
            • Update Member Group
            • Destroy Member Group
          • Types
            • List Member Groups Types
        • Programs
          • Introduction
          • Create Program
          • List Programs
          • Show Program
          • Update Program
          • Destroy Program
        • Benefits
          • Introduction
          • Create Benefit
          • List Benefits
          • Show Benefit
          • Update Benefit
          • Archive Benefit
          • Restore Benefit
          • Destroy Benefit
        • Cars
          • Show Cars Configuration
          • Update Cars Configuration
        • Webhooks
          • Introduction
          • Subscriptions Management
            • List Members Notifications Subscriptions
            • Create Members Notifications Subscription
            • Update Members Notifications Subscription
            • Destroy Members Notifications Subscription
        • Misc
          • Generate Link
        • Receipts
          • Introduction
          • List Submissions
          • Show Submission
          • Update Submission
          • Check Limits Exceeded
      • Stores
        • V4 API
          • Stores
            • Store Model
            • List Stores
            • Show Store
            • Create Store
            • Update Store
            • Archive Store
            • Restore Store
            • Destroy Store
            • Update Store receipt information
          • Retailers
            • Retailer Model
            • List Retailers
            • Show Retailer
          • Categories
            • StoreCategory Model
            • List Stores Categories
            • Show Stores Category
            • Create Stores Category
            • Update Stores Category
            • Destroy Stores Category
          • Store Categories
            • Add Store To Category
            • Remove Store From Category
            • Bulk Update Store Categories
        • V3 API
          • Stores
            • List Stores
            • Show Store By Store ID
            • Show Store
            • Create Store
            • Update Store By Store ID
            • Update Store
            • Delete Store By Store ID
            • Delete Store
            • List User Stores
          • Categories
            • List Store Categories
          • Zones
            • List Stores Zones
          • Floors
            • List Stores Floors
          • Tenant Categories
            • List Stores Tenant Categories
          • Store events
            • Create Store Event
          • Departments
            • List Store Departments
            • Show Store Department By Department ID
            • Create Store Department
            • Update Store Department by Department ID
            • Update Store Department
      • Offers
        • Introduction
        • Offers
          • Show Offer
          • List Offers
          • List Offers Groups
          • Create Offers
          • Update Offers
          • Clone Offers
          • Grant Offers
          • Archive Offers
        • Collections
          • List Collections
          • Show Collection
          • Create Collection
          • Update Collection
          • Archive Collection
          • Update Collections Order
        • Image Templates
          • Introduction
          • List Offer Image Templates
          • Show Offer Image Template
          • Preview Offer Image Template
          • Create Offer Image Template
          • Update Offer Image Template
          • Destroy Offer Image Template
        • Files
          • Introduction
          • Show File Schema
      • Rewards
        • Points expiration notifications policy
          • Introduction
          • Show Points Expiration Notifications Policy
          • Update Points Expiration Notifications Policy
      • Triggerer
        • Rules
          • Introduction
          • List Triggerer Rules
          • Show Triggerer Rule
          • Create Triggerer Rule
          • Update Triggerer Rule
          • Pause Triggerer Rule
          • Start Triggerer Rule
          • Delete Triggerer Rule
        • Event Types Schema
          • Show Event Types Schema
        • Point Multipliers
          • Introduction
          • List Point Multipliers
          • Show Point Multiplier
          • Create Point Multiplier
          • Update Point Multiplier
          • Destroy Point Multiplier
      • CMS
        • Introduction
        • Pages
          • Page Model
          • List Services
          • List Pages
          • Show Page
          • Create Page
          • Update Page
          • Archive Page
          • Restore Page
          • Destroy Page
        • Components
          • Component Model and Schema
          • System Components
          • Custom Components
            • Introduction
            • List Custom Components
            • Show Custom Component
            • Create Custom Component
            • Update Custom Component
            • Archive Custom Component
            • Restore Custom Component
            • Destroy Custom Component
          • Show Components Schema
          • Validate Component
        • Website
          • Website Model
          • Show Website
          • Update Website
        • Website Domains
          • Introduction
          • List Website Domains
          • Show Website Domain
          • Create Website Domain
          • Update Website Domain
          • Destroy Website Domain
        • Venue Info
          • Introduction
          • Show Venue Info
          • Update Venue Info
        • Landing Pages
          • Introduction
          • List Landing Pages
          • Show Landing Page
          • Create Landing Page
          • Update Landing Page
          • Archive Landing Page
          • Restore Landing Page
          • Destroy Landing Page
        • Landing Page Templates
          • Introduction
          • Bee Templates
            • Introduction
            • List Bee Landing Page Templates
            • List Bee Landing Page Templates Tags
            • Show Bee Landing Page Templates
          • List Landing Page Templates
          • Show Landing Page Template
          • Create Landing Page Template
          • Update Landing Page Template
          • Destroy Landing Page Template
        • Articles
          • Article Model
          • List Articles
          • Show Article
          • Create Article
          • Update Article
          • Archive Article
          • Restore Article
          • Destroy Article
        • Events
          • Event Model
          • List Events
          • Show Event
          • Create Event
          • Update Event
          • Archive Event
          • Restore Event
          • Destroy Event
        • Events Groups
          • Introduction
          • List Events Groups
          • Show Events Group
          • Create Events Group
          • Update Events Group
          • Archive Events Group
          • Restore Events Group
          • Destroy Events Group
        • Job Postings
          • Introduction
          • List Job Postings
          • Show Job Posting
          • Create Job Posting
          • Update Job Posting
          • Archive Job Posting
          • Restore Job Posting
          • Destroy Job Posting
        • Press Releases
          • PressRelease Model
          • List Press Releases
          • Show Press Release
          • Create Press Release
          • Update Press Release
          • Archive Press Release
          • Restore Press Release
          • Destroy Press Release
        • Tags
          • Tag Model
          • List Tags
          • Show Tag
          • Create Tag
          • Update Tag
          • Destroy Tag
        • Service Messages
          • Introduction
          • List Service Messages
          • Show Service Message
          • Create Service Message
          • Update Service Message
          • Archive Service Message
          • Restore Service Message
          • Destroy Service Message
        • Content Prototypes
          • ContentPrototype Model
          • List Content Prototypes
          • Show Content Prototype
          • Create Content Prototype
          • Update Content Prototype
          • Destroy Content Prototype
          • List Organization Content Prototypes
          • Show Organization Content Prototype
          • Create Organization Content Prototype
          • Update Organization Content Prototype
          • Destroy Organization Content Prototype
        • Mixed Content
          • Search Mixed Content
        • Attachments
          • Attachment Model
          • List attachments
          • Show Attachment
          • Create Attachment
          • Update Attachment
          • Destroy Attachment
      • Events
        • Events
          • List Events
          • Show Event
          • Check Member Status
        • Checkins
          • Checkin Member to the Event
          • List Checkins
        • Invitations
          • Send Invitation
        • Registration
          • List Events
          • Show Event
          • Show Calendar
          • Register Member
          • Unregister Member
          • Show Member Available Actions
      • Games
        • Add Languages to Game
        • Add Component to Game
        • Show Game Schema
        • Show Single Game Schema
        • Show Game Components
        • List Games
        • Update Game Component
        • Delete Component Data
        • Show Game Details
        • Create Game
        • Update Game
        • Delete Game
        • Show Game Languages
      • Scraper
        • Scraper
          • Run Scraper
        • Shopping mall
          • List Scraped Shopping Malls
          • Show Scraped Shopping Mall
          • Add Scraped Shopping Mall
          • Update Scraped Shopping Mall
          • Delete Scraped Shopping Mall
        • Shopping mall language
          • List Scraped Languages
          • Show Scraped Language
          • Add Scraped Language
          • Update Scraped Language
          • Delete Scraped Language
        • Menu item
          • List Scraped Menu Items
          • Show Scraped Menu Item
          • Add Scraped Menu Item
          • Update Scraped Menu Item
          • Delete Scraped Menu Item
      • Files
        • Introduction
        • Uploads
          • Start Upload
          • Upload Part
          • Finish Upload
          • Activate Uploaded File
          • Upload status
        • Upload from URL
        • List File Records
        • Destroy File Records
      • Receipts
        • Introduction
        • Loyalty Club Configuration
        • Receipt Submissions
        • Show Receipts Configuration
        • Update Receipts Configuration
        • Show Receipt Submission
        • Update Receipt Submissions
        • List Receipt Submissions
    • Users API
      • Introduction
      • Users
        • Introduction
        • Account
          • Show Notifications Settings
          • Update Notifications Settings
        • List Users
      • Conversations
        • Introduction
        • Conversations
          • Mark Conversation as "received"
          • Create Conversation
          • List Conversations
          • Show Conversation
          • Mark Conversation as "seen"
          • Archive Conversation
        • Messages
          • Create Message
          • List Messages
          • Archive Message
      • Notifications
        • List Notifications
        • Show Notification
        • Mark all Notifications as Received
        • Mark Notification as Seen
        • Mark all Notifications as Seen
        • Mark Notification as Received
      • Subunits Scopes
        • List Subunits Scopes for User
    • Operations API
      • Introduction
      • Manager API
        • Introduction
        • Settings
          • Introduction
          • Show Operations Settings
          • Update Settings
        • ABM Links
          • List ABM Links
          • Show Unassigned ABM Links Count
          • Import ABM Links
        • Members
          • Show Contact
          • Delete Contact
          • Update Contact
        • Issues
          • Introduction
          • Reopen Issue
          • List Issue Types
          • List Issues
          • Show Issue
          • Accept Issue
          • Resolve Issue
        • Articles
          • Introduction
          • List Articles
          • Show Article
          • Create Article
          • Update Article
          • Destroy Article
        • Articles Categories
          • Introduction
          • List Categories
          • Show Category
          • Create Category
          • Update Category
          • Destroy Category
          • List Categories with Articles
        • Documents
          • Introduction
          • List Documents
          • Show Document
          • List Document Recipients
          • Create Document
          • Update Document
          • Add Recipients to the Document
          • Destroy Document
        • Resource Types
          • Introduction
          • Show Resource Type Schema
          • Update Resource Type Schema
        • Resources
          • Introduction
          • Delete Resource
          • List Resources
          • Show Resource
          • Accept Resource
          • Reject Resource
          • Create a Resource Reminder
        • Revenue Reporting
          • Introduction
          • List Store Tax Categories
          • Bulk Update Store Tax Categories
          • List Aggregated Reports
          • List Aggregated Reports As Csv
          • Show Policy
          • Update Policy
          • List Tax Categories
          • Bulk Update Tax Categories
          • Download revenue reports import template
          • Import revenue reports from file
        • Alerts
          • Introduction
          • Recall Alert
          • Deactivate Alert
          • List Alerts
          • Show Alert
          • List Alert Recipients
          • Create Alert
          • Accept Alert
          • Reject Alert
        • Alert Templates
          • Introduction
          • List Alert Templates
          • Show Alert Template
          • Create Alert Template
          • Update Alert Template
          • Destroy Alert Template
        • Footfall Reporting
          • List Footfall Reports
          • Bulk Update Reports
      • Tenant API
        • Introduction
        • Documents
          • Introduction
          • List Documents
          • Show Document
          • Confirm Document
        • Resource Types
          • Show Resource Type Schema
        • Resources
          • Introduction
          • List Resources
          • List Deleted Resources
          • Show Resource
          • Create Resource
          • Update Resource
          • Destroy Resource
          • Resubmit Resource
          • Restore Resource
        • Alerts
          • Introduction
          • List Alert Types
          • List Alerts
          • Show Alert
          • Create Alert
          • Report to Alert
        • Alert Templates
          • List Alert Templates
        • Push App Tokens
          • Introduction
          • Add App Tokens
        • Revenue Reporting
          • List Reporting Periods
          • List Reporting Period Reports
          • Bulk Update Reports
          • List Tax Categories
          • List Store Tax Categories
          • Bulk Update
        • ABM Links
          • Assign ABM Link
          • Send ABM Link
        • Issues
          • Introduction
          • List Issues
          • Show Issue
          • Create Issue
          • Update Issues
          • Destroy Issue
        • Articles
          • Introduction
          • List Articles
          • Show Article
          • List Categories with Articles
    • Messaging API
      • Introduction
      • Models
        • Message model
        • Channel model
        • Template model
        • Sending model
        • Dispatch model
        • Recipient model
        • MessagePayload model
        • SendingPayload Model
      • Messages
        • Create Message
        • List Messages
        • Show Message
        • Update Message
        • Delete Message
      • Sendings
        • Show Sending
        • List Sending Dispatches
        • List Sending Members
        • Create Sending
        • Update Sending
        • Cancel Sending
      • Templates
        • Bee Templates
          • Introduction
          • List Bee Email Templates
          • Show Bee Email Template
          • List Bee Email Templates Tags
        • List Templates
        • Show Template
        • Create Template
        • Update Template
        • Destroy Template
      • Sender Identities
        • SMS Sender Identities
          • Introduction
          • List SMS Sender Identity
          • Show SMS Sender Identity
          • Create SMS Sender Identity
          • Update SMS Sender Identity
          • Delete SMS Sender Identity
        • Email Sender Identities
          • Introduction
          • List Email Sender Identities
          • Show Email Sender Identity
          • Create Email Sender Identity
          • Update Email Sender Identity
          • Delete Email Sender Identity
      • Messaging History
        • Messages List
      • General
        • Show Settings
        • List Merge Properties
    • Data API
      • Introduction
      • Events
        • Members Events
          • MemberEvent Model
          • MemberEvent Types
          • Register Event for Member
          • Register Event for Current Member
          • Register Multiple Events for Member
          • Register Multiple Events for Current Member
          • Register Multiple Events
        • Receipts
          • Save Receipts Scans Data
          • Show Receipts Scans Data
        • Transaction Points
          • Save Transaction Points Data
          • Show Transaction Points Data
        • Wifi Events
          • Register Wifi Event
        • Offers Events
          • Register "clicked" Event
          • Register "seen" Event
        • Mobile Events
          • Register By Member Id
          • Register Multiple for Current Member
    • ML API
      • Introduction
      • Predict Sending KPI v1
      • Explain Sending KPI Prediction v1
      • Predict Sending KPI In Date Range v1
      • Predict Sending Popularity v2
      • Predict Sending Text Popularity v2
      • Predict Sending Time Series Popularity v2
      • Explain Sending Popularity Prediction v2
      • Explain Sending Text Popularity Prediction v2
      • Explain Sending Time Series Popularity Prediction v2
      • Recommend sending time v2
      • Generate Image
      • Generate Text
      • Generate Sending Text
    • (Draft) Reporting API
      • Introduction
      • Filter parameter specification
      • Data formats
        • Records
        • Timeseries
      • Reports
        • Members
          • members (records)
          • members_count (records)
          • members_grouped_count (records)
          • member_balance (timeseries)
          • members_count_snapshot (timeseries)
      • Geo API
        • Find Loactions Coordinates
        • List places
        • Show place
      • Metadata
      • Field metadata
      • Query (records)
      • Query (timeseries)
  • Other
    • Webhooks System
      • Introduction
      • WebhookEvent Model
      • Trackable Resources
  1. History

Show Service Usage History

GET
/v1/billing/service_usage/history
API Permit:Billing:Api:ServiceUsageHistory:Show
API Context:Customer
Authorizations:UserToken

Request

Query Params
from_offset
integer 
optional
Offset (in months) from current month for the start month of the report, if not provided, report will start from first customer service usage
>= 0<= 24
Example:
1
to_offset
integer 
optional
Offset (in months) from current month for the end month of the report, if not provided, report will end at last month that customer has any usage record (typically current month), if provided cannot be greater than from_offset
Example:
1
Header Params
Content-Type
enum<string> 
required
Details
Allowed value:
application/json
Default:
application/json
X-User-Agent
string 
required
Arbitrary identifier of your client. Details
Default:
{{X_USER_AGENT}}
X-Product-Name
string 
required
API Product for API context. Details
Default:
{{PRODUCT_NAME}}
X-Loyalty-Club-Slug
string 
required
LoyaltyClub for API context. Details
Default:
{{LOYALTY_CLUB_SLUG}}
X-Customer
string 
required
Customer for API context. Details
Default:
{{CUSTOMER_ID}}
X-Client-Authorization
string 
optional
Default:
{{API_TOKEN}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/billing/service_usage/history?from_offset=1&to_offset=1' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success
application/json
Body
service_usage_history
array[object (ServiceUsageHistory) {2}] 
required
period
string 
required
Example:
01.2025
data
array [object {2}] 
required
Example
{
  "service_usage_history": [
    {
      "period": "04.2025",
      "data": [
        {
          "service": "domains",
          "usage": "0.0"
        }
      ]
    }
  ]
}
Modified at 2025-04-30 13:27:24
Previous
Delete Recurring charge
Next
List Service Usages
Built with