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

Request

{
"subscription": {
"billingEmail": "STRING",
"billingName": "STRING",
"coupon": "ENUMERATED STRING",
"planId": "STRING IDENTIFIER",
"token": "STRING",
"trialDays": INTEGER
}
}

billingEmail

OPTIONAL - String
Validation: Valid email
The email address that invoices will be sent to. Defaults to the EyeLevel customer email.

billingName

OPTIONAL - String
The name that invoices will be addressed to. Defaults to the EyeLevel customer name.

coupon

OPTIONAL - String
Validation: 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.

planId

REQUIRED - String
Validation: Value is an existing EyeLevel subscription plan identifier
Then unique identifier for the subscription plan that will be applied to the EyeLevel customer account.

token

REQUIRED - String
Validation: A Stripe source token
A valid Stripe source token for a credit card.

trialDays

OPTIONAL - Integer
The number of days before billing will start.

Response

{
"subscription": {
"amount": INTEGER,
"billingEmail": "STRING",
"billingName": "STRING",
"cancelAt": DATETIME,
"currency": "ENUMERATED STRING",
"interval": "ENUMERATED STRING",
"name": "STRING",
"subscriptionId": "STRING IDENTIFIER",
"subscriptionStart": DATETIME,
"trialEnd": DATETIME
}
}

amount

The price in cents (represented as a whole integer if possible) of the subscription plan per month or per year.

anchor

The datetime in RFC3339 format that billing periods are based off of.

cancelAt

The datetime in RFC3339 format when the subscription will end.

currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

interval

The frequency of billing periods, either month or year.

name

The human readable name for the subscription plan.

subscriptionId

The unique identifier for the subscription. You can use this id in other subscription API requests.

subscriptionStart

The datetime in RFC3339 format when the subscription was started.

trialEnd

The datetime in RFC3339 format when the trial period for the subscription ends.
Copy link
On this page
post
START
Request
billingEmail
billingName
coupon
planId
token
trialDays
Response
amount
anchor
cancelAt
currency
interval
name
subscriptionId
subscriptionStart
trialEnd