API Reference

Create and send a subscription.

post
https://api.securelyme.io/subscriptions/create
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 24

Description to keep track of subscription requests.

string
required
length between 1 and 2500

Message to the customer that is included when viewing the subscription request.

int32
required
1 to 2147483647

Securely customer id to create the subscription request for.

string
length ≤ 250

Internal notes for the subscription request, not viewable to the customer.

string
required
length ≥ 1

Invoice number from the api consumer system to help identify the subscription request.

double
required
≥ 0.01

Amount for the subscription (>= $0.01).

attachment
object

File to be attached to the subscription request, visible to the customer.

string
required
length ≥ 1

Subscription cycle desc (WEEKLY, EVERY OTHER WEEK, BIMONTHLY(1st and 15th), MONTHLY, QUARTERLY, YEARLY)

date-time

Subscription end date

date-time
required
length ≥ 1

Subscription start date

boolean

Indicates if an email/text should be sent to the customer informing them when subscription payment request is sent.

boolean

Indicates if an email/text should be sent to the customer informing them when a payment has completed. Default is true.

boolean

Indicates if an email/text should be sent to the customer informing them about the subscription. Default is true.

int32

Primary/Customer assigned plan used by default if not supplied.

string
length ≤ 250

External identifier for subscription request. Expected to be a unique identifier from the API consumer's system.

Response

Updated 9 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?