App Dashboard
API Reference

Create a plan

post
https://api.revenuehq.dev/applications//plan-groups//plans

Creates a new plan within an existing a plan group. Plans are enabled upon creation. The first plan for each plan group is also set as the default for the plan group.

Returns the full plan object.

Authorized scopes:

  • owner
  • admin:full
  • admin:limited
  • application:update
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The id of the application.

uuid
required

The id of the plan group.

Body Params
string
required

The human-readable name to give this plan. This name will be publicly viewable by accounts in the account management page.

periodicity
object
required

The recurring periodicity for the plan. Any potential discounts or offers should not be considered -- only the final recurring periodicity. Unless the underlying plan group is managed by the Promo billing system, the duration must be a positive, non-zero value.

If the plan group is managed by the Promo billing system, the duration can be zero, which indicates that the plan will last forever.

entitlements
array of strings

The names of the entitlements that are included in this plan. Will be pulled from the application's defined entitlements.

entitlements
string

If defined, this will appear as a pill overlay on top of the plan to draw attention.

Headers
integer
Responses

401

Unauthorized

Updated 8 months ago

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

Updated 8 months ago