API Reference

Create a new plan

post
https://api.heymantle.com/v1/apps//plans

Create a new plan for a specific app.

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

The ID of the app.

Body Params
string

The name of the plan.

string

The description of the plan.

string

The billing interval of the plan.

string

The currency code for the plan.

number

The amount for the plan.

integer

The number of trial days for the plan.

boolean

Indicates if the plan is public.

boolean

Indicates if the plan is visible.

customerTags
array of strings

Tags for customers.

customerTags
customerExcludeTags
array of strings

Tags to exclude customers.

customerExcludeTags
shopifyPlans
array of strings

Shopify plans associated with the plan.

shopifyPlans
customer
object

Customer information.

planUsageCharges
array of objects

Usage charges for the plan.

planUsageCharges
customFields
object

Custom fields for the plan.

string

The type of the plan.

boolean

Indicates if the plan has flexible billing.

flexBillingTerms
object

Terms for flexible billing.

string

Action when usage limit is reached.

string

Plan ID to auto-upgrade to.

boolean

Indicates if pending usage should roll over.

number

Capped amount for usage charges.

features
array of objects
features
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?