Stykite
  1. Customer
Stykite
  • Introduction
    • What is Stykite?
    • Who should use Stykite?
    • When Stykite isn't the right fit?
    • Key Concepts
    • Pre-requisites: Account & API Keys
  • Getting Started
    • Setup your Tracking & Billing
    • Integrate Subscription Plans & Payments
    • Setup Payments
      • Configuring Razorpay Webhooks for Stykite
  • API Reference
    • Customer Facing Widgets
      • Pricing Widget Integration Guide
      • My Account Widget Integration
      • Subscribe Button
    • API Reference
      • Webhooks
        • Customer Subscription Status Update
        • Add-on Purchase Success
      • Usage
        • Send Usage
      • Customer
        • Create Customer with Auto Subscribe
          POST
        • Get Customer and Subscription Details
          GET
        • Update Customer Meter Entitlements
          PUT
      • Subscription
        • Create Subscription
        • Cancel Subscription
        • Update Subscription
      • Checkpoint
        • Track Checkpoint Usage API
  • Learning Stykite
    • Subscriptions & Plans
    • Add-ons
    • Pricing Versions
    • Manual Subscriptions & Exclusive Plans
    • Invoices
    • Payments
    • Sales Tax
    • Customers
    • Transactions & Refunds
    • Settings
  1. Customer

Update Customer Meter Entitlements

PUT
/v1/company/{companyId}/country/{countryId}/customer/{customerIdentfier}/meter-entitlements
This API endpoint allows you to update or assign entitlements to one or more usage meters for a specific customer.
It is typically used to allocate or adjust metered features such as credits, seats, or usage limits.
NameTypeRequiredDescriptionExample
companyIdstring✅The unique identifier of the companyCOM-0FNWT0H89QS36
countryIdstring✅The unique identifier of the countryCON-0AZZVPQHM475V
customerIdentifierstring✅The email address of the customeronkar.kore+86@stykite.com
NameTypeRequiredDescriptionExample
Authorizationstring✅Bearer token for authenticationBearer <api-key>
Content-Typestring✅Content type of request payloadapplication/json
FieldTypeRequiredDescriptionExample
meter_tsidstring✅The unique identifier of the meterMTR-0MB95BFFX5MY2
entitlementinteger✅The entitlement value (e.g., credits, seats)1
Example:
[ { "meter_tsid": "MTR-0MB95BFFX5MY2", "entitlement": 1 }, { "meter_tsid": "MTR-0MB8WXFSD5YVW", "entitlement": 1 } ]
Response
200 — Success
Field Type Description
status boolean Indicates if the operation was successful
value object Response payload containing customer data
customer_email string The customer email
entitlements array List of meter entitlements assigned/updated

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Header Params

Body Params application/json

Example
[
    {
        "meter_tsid": "MTR-0MB95BFFX5MY2",
        "entitlement": 1
    },
    {
        "meter_tsid": "MTR-0MB8WXFSD5YVW",
        "entitlement": 1
    }
]

Request Code 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 PUT 'https://sandbox.api.stykite.com/v1/company//country//customer//meter-entitlements' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "meter_tsid": "MTR-0MB95BFFX5MY2",
        "entitlement": 1
    },
    {
        "meter_tsid": "MTR-0MB8WXFSD5YVW",
        "entitlement": 1
    }
]'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2025-10-05 12:22:22
Previous
Get Customer and Subscription Details
Next
Create Subscription
Built with