Create a Subscription

This endpoint enables you to automatically bill a customer through a subscription. You can set the start date, billing cycle, and other parameters. Alternatively you can send out an recurring invoice every month using this endpoint

Note: The customer must have an authorized funding source in the system. You can create a customer and add a verified funding source using the create customer endpoint.

📘

Before using any endpoint, you need to set the environment:

Click on Environment in the Base URL and enter the appropriate option:
api (Production) for the live environment.
sandbox (Sandbox) for testing.

Body Params
string
required

Email or id of sender, with On-demand Funding Source

string
required

Name of sender

string
required

Payment amount

string
required

Description or memo for invoice

string

Your unique label

string
enum
required

'month' or 'week' or 'bi-weekly' or 'day'

Allowed:
string
required

Number of payments

string

Start date (YYYY-MM-DD)

string

Payment number

string

Credit account id for funds (if recipient has multiple bank account).

string

Base64 encoded PDF attachment for sender

Response

Language
Credentials
Header
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json