subscribe

Developing

POST

/organization/subscribe/payment-methods/{paymentType}/subscribe

Create Subscription for Organization

📣 This Endpoint create a subscription package for organization. In this POST request Plan Code and Plan Method ID has to be provided in the url and In the response you will get a confirmation of subscription if it's successful

✳ Example JSON Payload

{
    "plan_code" : "daily-01",
    "payment_method_id" : "pm_1PXHIqIkSeCp7envQi6i7OIX"
}

🔰 Each payload in details of this POST Request,

plan_code: a small string (e.g. monthly-01, daily-01, year-01)

payment_method_id : a string field for the payment method id (e.g. pm_1PXHIqIkSeCp7envQi6i7OIX)

📢 Info message : Here the POST request enpoint is constructed like /organization/subscribe/payment-methods/stripe/subscribe

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

paymentType

string

required

Example:

stripe

Body Params application/json

plan_code

string

required

the plan code which organization want to purchase

payment_method_id

string

required

payment method id (e.g. provided from stripe library)

Example

{
    "plan_code" : "daily-01",
    "payment_method_id" : "pm_1PXHIqIkSeCp7envQi6i7OIX"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:8080/v1/organization/subscribe/payment-methods/stripe/subscribe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "plan_code" : "daily-01",
    "payment_method_id" : "pm_1PXHIqIkSeCp7envQi6i7OIX"
}'

Responses

🟢200OK

application/json

Body

object {0}

Example

{}

Modified at 2024-08-07 09:57:44

discribe a plan by planCode

cancel subscription

Create Subscription for Organization#

Request

Request samples

Responses

Create Subscription for Organization