START SUBSCRIPTION
Start a subscription that will be associated with the given customer API key
post
https://api.eyelevel.ai/v1/partner
/subscription/:apiKey
START
{
"subscription": {
"billingEmail": "STRING",
"billingName": "STRING",
"coupon": "ENUMERATED STRING",
"planId": "STRING IDENTIFIER",
"token": "STRING",
"trialDays": INTEGER
}
}
OPTIONAL - StringValidation: Valid email
The email address that invoices will be sent to. Defaults to the EyeLevel customer email.
OPTIONAL - String
The name that invoices will be addressed to. Defaults to the EyeLevel customer name.
OPTIONAL - StringValidation: Value is one of the pre-defined enumerated values
The coupon code that will be applied to the subscription plan. Coupon codes must be setup in coordination with EyeLevel support.
REQUIRED - StringValidation: Value is an existing EyeLevel subscription plan identifier
Then unique identifier for the subscription plan that will be applied to the EyeLevel customer account.
REQUIRED - StringValidation: A Stripe source token
A valid Stripe source token for a credit card.
OPTIONAL - Integer
The number of days before billing will start.
{
"subscription": {
"amount": INTEGER,
"billingEmail": "STRING",
"billingName": "STRING",
"cancelAt": DATETIME,
"currency": "ENUMERATED STRING",
"interval": "ENUMERATED STRING",
"name": "STRING",
"subscriptionId": "STRING IDENTIFIER",
"subscriptionStart": DATETIME,
"trialEnd": DATETIME
}
}
The price in cents (represented as a whole integer if possible) of the subscription plan per month or per year.
The datetime in RFC3339 format that billing periods are based off of.
The datetime in RFC3339 format when the subscription will end.
The frequency of billing periods, either month or year.
The human readable name for the subscription plan.
The unique identifier for the subscription. You can use this id in other subscription API requests.
The datetime in RFC3339 format when the subscription was started.
The datetime in RFC3339 format when the trial period for the subscription ends.
Last modified 1yr ago