Skip to main content
POST
Add a draft milestone rule

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
name
string
required
Maximum string length: 255
trigger_type
enum<string>
required

A rule keeps its trigger type for life.

Available options:
first_order,
nth_order,
every_nth_order,
anniversary
grant_per
enum<string>
required
Available options:
subscription,
order
items
object[]
required
Required array length: 1 - 20 elements
starts_at
string<date-time> | null

When the rule starts. Null or left out for at once.

ends_at
string<date-time> | null

When the rule ends. Null or left out for never.

trigger_value
integer | null

N. Leave it out for first_order. anniversary defaults to 12 months.

scope
enum<string>
default:all
Available options:
all,
plans,
products,
variants
scope_ids
integer[]

Plans, products or variants of the company. Empty for all.

out_of_stock_policy
enum<string>
default:substitute_then_defer
Available options:
substitute_then_defer,
substitute_then_skip,
skip
volume_policy
enum<string>
default:zero
Available options:
zero,
catalog
visibility
enum<string>
default:announced
Available options:
announced,
surprise
max_grants_per_subscription
integer | null
Required range: x >= 1

Response

The draft rule

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