Create Subscription Plan

post

https://api-sandbox.paymentlabs.io/subscription/plans

Creates a subscription plan

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

merchantDisplayName

string

required

The merchant's display name

sort

string

required

Sorting information, this can be used to order and group the plans

For example, you can use this to group plans by type, or to order them by price

PromotionalPlan#100
PromotionalPlan#200
RegularPlan#100
RegularPlan#200

name

string

required

The plan's name

description

string

A brief description for the plan

schedule

object

required

trialPeriod

object

enabledCheckoutInstruments

array of objects

required

The enabled checkout instruments for this plan

enabledCheckoutInstruments*

auditInfo

object

required

Information about changes

termsOfServiceUrl

string

required

The merchant's terms of service url that will be displayed to the buyer

privacyPolicyUrl

string

required

The merchant's privacy policy url that will be displayed to the buyer

amount

number

required

The amount to be charged for the plan for each scheduled interval

currency

string

required

The currency for this plan

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

401Unauthorized response, when the user is not authenticated or the authentication token is missing in the header.

403 Forbidden response, when the user is authenticated but does not have the necessary permissions.