Skip to main content
POST
/
api
/
v1
/
subscriptions
Create a new subscription
curl --request POST \
  --url https://dev-billing-api.iqraa.ai/api/v1/api/v1/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "planCode": "PREMIUM_MONTHLY",
  "isTrial": false,
  "seats": 5,
  "userEmail": "john.doe@example.com",
  "userName": "John Doe"
}
'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
planCode
string
required

The unique code identifying the subscription plan

Example:

"PREMIUM_MONTHLY"

​
isTrial
boolean
default:false

Indicates if this is a trial subscription

Example:

false

​
seats
number

Number of seats/licenses for the subscription

Required range: 1 <= x <= 1000000
Example:

5

​
userEmail
string

Email address of the subscription owner

Example:

"john.doe@example.com"

​
userName
string

Full name of the subscription owner

Example:

"John Doe"

Response

Subscription created successfully