Authorizations
The app API key from an app from the /dashboard/developer page
Body
Parameters for CreatePlan
The company the plan should be created for.
"biz_xxxxxxxxxxxxxx"
The access pass the plan is related to.
"prod_xxxxxxxxxxxxx"
The interval at which the plan charges (renewal plans).
42
The respective currency identifier for the plan. The available currencies on the platform
usd
, sgd
, inr
, aud
, brl
, cad
, dkk
, eur
, nok
, gbp
, sek
, chf
, hkd
, huf
, jpy
, mxn
, myr
, pln
, czk
, nzd
, aed
, eth
, ape
, cop
, ron
, thb
, bgn
, idr
, dop
, php
, try
, krw
, twd
, vnd
, pkr
, clp
, uyu
, ars
, zar
, dzd
, tnd
, mad
, kes
, kwd
, jod
, all
, xcd
, amd
, bsd
, bhd
, bob
, bam
, khr
, crc
, xof
, egp
, etb
, gmd
, ghs
, gtq
, gyd
, ils
, jmd
, mop
, mga
, mur
, mdl
, mnt
, nad
, ngn
, mkd
, omr
, pyg
, pen
, qar
, rwf
, sar
, rsd
, lkr
, tzs
, ttd
, uzs
, rub
, btc
An array of custom field objects.
The description of the plan.
The interval at which the plan charges (expiration plans).
42
An additional amount charged upon first purchase.
6.9
A personal description or notes section for the business.
An override for tax to specify for this specific plan. Whether or not the tax is included in a plan's price (or if it hasn't been set up)
inclusive
, exclusive
, unspecified
Indicates if the plan is a one time payment or recurring. The type of plan that can be attached to an access pass
renewal
, one_time
This is the release method the business uses to sell this plan. The methods of how a plan can be released (including raffles and waitlists).
buy_now
, waitlist
The amount the customer is charged every billing period.
6.9
The number of free trial days added before a renewal plan.
42
Shows or hides the plan from public/business view. Visibility of a resource
visible
, hidden
, archived
, quick_link
Response
A successful response
An object representing a (sanitized) plan of an access pass.
The internal ID of the plan.
"plan_xxxxxxxxxxxxx"
When the plan was created.
1701406800
When the plan was last updated.
1701406800
Shows or hides the plan from public/business view. Visibility of a resource
visible
, hidden
, archived
, quick_link
Indicates if the plan is a one time payment or recurring. The type of plan that can be attached to an access pass
renewal
, one_time
This is the release method the business uses to sell this plan. The methods of how a plan can be released (including raffles and waitlists).
buy_now
, waitlist
The respective currency identifier for the plan. The available currencies on the platform
usd
, sgd
, inr
, aud
, brl
, cad
, dkk
, eur
, nok
, gbp
, sek
, chf
, hkd
, huf
, jpy
, mxn
, myr
, pln
, czk
, nzd
, aed
, eth
, ape
, cop
, ron
, thb
, bgn
, idr
, dop
, php
, try
, krw
, twd
, vnd
, pkr
, clp
, uyu
, ars
, zar
, dzd
, tnd
, mad
, kes
, kwd
, jod
, all
, xcd
, amd
, bsd
, bhd
, bob
, bam
, khr
, crc
, xof
, egp
, etb
, gmd
, ghs
, gtq
, gyd
, ils
, jmd
, mop
, mga
, mur
, mdl
, mnt
, nad
, ngn
, mkd
, omr
, pyg
, pen
, qar
, rwf
, sar
, rsd
, lkr
, tzs
, ttd
, uzs
, rub
, btc
The company for the plan.
The access pass for the plan.
The invoice associated with this plan.
The interval at which the plan charges (renewal plans).
42
The description of the plan.
The direct link to purchase the access pass.
The interval at which the plan charges (expiration plans).
42
The price a person has to pay for a plan on the initial purchase.
6.9
The price a person has to pay for a plan on the renewal purchase.
6.9
The number of free trial days added before a renewal plan.
42
The number of members for the plan.
42
A personal description or notes section for the business.
The tax type for the plan. Whether or not the tax is included in a plan's price (or if it hasn't been set up)
inclusive
, exclusive
, unspecified
Whether or not the plan collects tax.
The custom fields for the plan.