API Reference

Create Plan

post
https://mapi.boomfi.xyz/v1/plan

The Create Plan endpoint allows you to create a new subscription plan. It requires a payload containing the plan's details. Use this endpoint to create flexible and tailored subscription options that align with your business needs.

Note

When creating a plan, you automatically create a paylink associated with it. This allows you to offer the plan for immediate purchase.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The amount associated with the plan, specified as a string. This parameter represents the cost or price of the plan.

string

The currency in which the plan amount is expressed.

string

A brief description or summary of the plan. This parameter provides additional information about the purpose or features of the plan.

string
enum

The recurring interval for the payment link:

  • Week
  • Month
  • Year
Allowed:
integer

The number of intervals between each billing cycle. This parameter determines how often the plan is billed within the specified interval.

metadata
object

An object containing additional metadata associated with the plan.

string

A name or label associated with the plan. This parameter represents a identifier or title for the plan.

string

A reference identifier associated with the plan. This parameter allows for linking the plan to external identifiers.

string

Specifies the trial period duration for the plan, if applicable. This parameter represents the duration of any trial period associated with the plan.

Responses

Updated 22 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago