API Reference
Release-5.0.0
Log In
API Reference
  1. Collections API
  2. Recurring Payments

Add a customer to a recurring payment plan

post
https://prod.api.getborderless.com/addCustomersToRecurringPaymentPlan

Introduction

This endpoint allows you to add a customer to a recurring payment plan. Use this endpoint to send a subscription request that will then allow you to use the borderless™ Collections API to collect payments automatically.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The borderless™ planId denoting the plan which you want to invite a customer to subscribe to. This is available in the borderless™ dashboard when you click, View Plan Details.

customers
array of objects
required

Array of objects containing either a key of “slug” (slug is customer @handle. Read more about borderless™ @handles) or “email” with values that correspond to the customer you wish to add to the plan. If both are given, the slug (customer @handle without the '@') will be used.

customers*
Headers
string

Unique identifier of Child Account (required only for Partner).

Responses

404

Server Error

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?