Create Subscription

Endpoint

POST /v1/company/:companyId/country/:countryId/payment

Description

Creates a new payment transaction for a customer against a selected plan.
This endpoint is typically used to initiate a payment when a user subscribes to a plan.

Request

Headers

Key	Value	Required
`Authorization`	`Bearer <API_KEY>`	✅
`Content-Type`	`application/json`	✅

Path Parameters

Parameter	Type	Description	Required
`companyId`	string	Unique identifier of the company	✅
`countryId`	string	Unique identifier of the country (pricing region)	✅

Body Parameters

Field	Type	Description	Required
`customer_identifier`	string	Unique identifier for the customer (e.g., email, user ID)	✅
`plan_id`	string	The plan identifier you want to subscribe to	✅
`plan_type`	string	Type of subscription plan (`MONTHLY` or `YEARLY`)	✅
`payment_component`	string	Defines what is being charged (e.g., `PLAN`, `ADDON`)	✅

Sample Request

Response

Response Fields

Field	Type	Description
`status`	boolean	Indicates if the API request was successful
`value.transaction_tsid`	string	Unique transaction identifier for the created payment

Sample Response

{
  "status": true,
  "value": {
    "transaction_tsid": "TRN-0MSC9073DVBTK"
  }
}

Error Codes

Code	Description
400	Missing or invalid request parameters
401	Invalid or missing API key
404	Company or country not found
500	Internal server error

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

{
    "customer_identifier": "onkar@stykite.com",
    "plan_id": "PLV-0MD508X1S388G",
    "plan_type": "MONTHLY",
    "payment_component": "PLAN"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Create Subscription

Create Subscription#

Endpoint#

Description#

Request#

Response#

Error Codes#

Request

Request Code Samples

Responses

Create Subscription

Endpoint

Description

Request

Response

Error Codes