Skip to main content
POST
Start a tenure program

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
name
string
required

The program's name.

Required string length: 1 - 255
axis
enum<string>
required

What tenure counts. It never changes after the program is created.

Available options:
paid_orders,
months_subscribed
scope
enum<string>
default:all

Which subscriptions the program covers.

Available options:
all,
plans,
products
scope_ids
integer[]

The company's subscription plan ids for a plans scope, or product ids for a products scope. Empty for all.

Maximum array length: 500

Response

Created

tenure_program
object
required
status
enum<integer>
required
Available options:
200,
201
meta
object
required