Create a new Membership / Subscription

post http://api.tidyhq.com/v2/membership_levels/{membershipLevelID}/subscriptions

Creates a new subscription, which will in turn create an associated membership.

This endpoint allows the progmatic addition of members, and associated control over the details of the given member.

Path Params

membershipLevelID

string

required

The membership level to subscribe to.

Body Params

member

object

Required if an individual membership level, denotes who it belongs to.

adult

array of objects

For family memberships, the associated adults.

adult

children

array of objects

For family memberships, the associated children.

children

variations

object

A object mapping variation ids to variation value ids.

payment_type

required

Payment status of subscription, note that paid covers partially paid subscriptions.

payment_method

Required when payment_type is paid, How the paid amount was paid. One of "cash", "card", "cheque", "bank", "other"

partial_payment_amount

string

When marked as paid, and it's already partially-paid, an amount that has already been paid.

ref_no

string

When marked as paid, allows overriding the transaction ref for the given paid transaction. If left blank, will be automatically generated.

due_date

string

When paying by invoice, when said invoice is due.

send_welcome_mail

boolean

Defaults to true

Send a membership welcome email.

send_invoice_mail

boolean

When paying by invoice, should we send an email with invoice details.

auto_assign_users

boolean

Defaults to true

When processing contacts on the membership, should we automatically assign (either find existing, or create a new) user for them in Tidy. If users are created, will automatically send an account sign up email as well. For users to be automatically created / assigned, they require all of a first name, last name and an email address.

auto_renew

boolean

Will set explicitly if the membership should auto renew, if possible. Defaults to use the value set on the membership level, but can overwrite if needed.

start_date

date

end_date

date

Response

Language


xxxxxxxxxx
11
1
curl --request POST \
2
     --url http://api.tidyhq.com/v2/membership_levels/membershipLevelID/subscriptions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "payment_type": "paid",
8
  "send_welcome_mail": true,
9
  "auto_assign_users": true
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK