Get Customer and Subscription Details

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

companyId

string

required

Example:

countryId

string

required

Example:

customerIdentifier

string

required

Example:

Header Params

Authorization

string

required

Example:

Bearer {{AUTH_TOKEN}}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Example

application/json

Body

status

boolean

required

value

object

required

tsid

string

required

customer_identifier

string

required

created_at

integer

required

updated_at

integer

required

company_tsid

string

required

country_tsid

string

required

plan

null

required

subscription_start_date

null

required

subscription_end_date

null

required

plan_type

null

required

subscription_status

null

required

string

required

card_last_4

null

required

card_network

null

required

first_name

string

required

last_name

string

required

phone

string

required

billing_address

object

required

reason

null

required

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
    }
}