Create
string
required
Membership name.
decimal
required
Amount charged each cycle.
integer
required
Charge every n units.
string
required
days, weeks, months or years.integer
required
Minimum contract length, in cycles. Minimum 1.
decimal
default:"0"
One-off fee at sign-up.
decimal
default:"0"
Also
trial_period[length] (default 0) and trial_period[unit] (default days).boolean
default:"false"
true ends the membership at the end of the contract; false continues until further notice.decimal
default:"0"
Charged if cancelled before
min_length is reached.boolean
default:"false"
On early cancellation, charge the remaining contract value.
uuid
The merchant the membership belongs to.
uuid
The membership ID — use it as
membership_id when creating a subscription.integer
Numeric reference, for display.
object
amount, interval (number of instalments in the minimum term), length (every n units), unit.object | false
false when there is no trial; otherwise amount, length, unit.boolean
boolean | string
true when no rule is configured; "Original Amount" or "Remaining Amount" when the remaining contract is charged on early cancellation.string | null
Cancellation fee label.