Create and send an e-bill.

post

https://api.securelyme.io/e-bills/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

memo

string

required

length between 1 and 24

Description to keep track of e-bill requests.

customerMessage

string

required

length between 1 and 2500

Message to the customer that is included when viewing the e-bill request.

customerUserId

int32

required

1 to 2147483647

Securely customer ID to create the e-bill request for.

internalNotes

string

length ≤ 250

Internal notes for the e-bill request, not viewable to the customer.

invoiceNumber

string

required

length ≥ 1

Invoice number from the api consumer system to help identify the e-bill request.

amount

double

required

≥ 0.01

Amount for the e-bill (>= $0.01).

attachment

object

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

frequency

string

required

length ≥ 1

e-bill cycle desc (ONCE, WEEKLY, EVERY OTHER WEEK, BIMONTHLY(1st and 15th), MONTHLY, QUARTERLY, YEARLY)

endDate

date-time

e-bill end date

effectiveDate

date-time

required

length ≥ 1

e-bill start date

paymentTermValue

int32

Term value in days when the payment is due. (0, 15, 30, 45, 60). If set to 0 the payment is due upon receipt.

alternatePricingPlanId

int32

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

sendReceipt

boolean

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

sendNotice

boolean

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

externalIdentifier

string

length ≤ 250

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

Response

Language

Credentials

Basic

base64

Loading…

Response

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

application/json

200Created e-bill id.