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

Get Customer and Subscription Details

GET
/v1/company/{companyId}/country/{countryId}/customer/{customerIdentifier}
This API endpoint allows you to retrieve detailed information about a specific customer, including their subscription status and associated details. It provides a comprehensive view of the customer’s profile and their active subscriptions.
Request Parameters
Path Parameters:
company_id (string, required): The unique identifier of the company.
country_id (string, required): The unique identifier of the country.
customer_identifier (string, required): A unique identifier for the customer.
Headers:
Authorization (string, required): The authorization token in the format Bearer .

Request

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

Header Params

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 -g --request GET 'https://sandbox.api.stykite.com/v1/company/COM-0FR3TQHKW0YBJ/country/CON-0AZZVPQHM475V/customer/c56164ad-3d54-4eaa-ae3d-46fe3969972b' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Example
application/json
Body

Example
{
    "status": true,
    "value": {
        "tsid": "CUS-0G9HCNK3E4P1Y",
        "customer_identifier": "c56164ad-3d54-4eaa-ae3d-46fe3969972b",
        "created_at": 1717837601565,
        "updated_at": 1717837601565,
        "company_tsid": "COM-0FR3TQHKW0YBJ",
        "country_tsid": "CON-0AZZVPQHM475V",
        "plan": null,
        "subscription_start_date": null,
        "subscription_end_date": null,
        "plan_type": null,
        "subscription_status": null,
        "email": "onkar.kore@stykite.com",
        "card_last_4": null,
        "card_network": null,
        "first_name": "Onkar",
        "last_name": "Kore",
        "phone": "8149712450",
        "billing_address": {
            "city": "Bangalore",
            "country": "India",
            "line1": null,
            "line2": null,
            "state": "Karnataka",
            "city_code": "Bangalore",
            "country_code": "IN",
            "postal_code": "416013",
            "state_code": "KA"
        },
        "reason": null
    }
}
Modified at 2024-06-08 10:21:08
Previous
Create Customer with Auto Subscribe
Next
Update Customer Meter Entitlements
Built with