Skip to main content
POST
/
bulk-plans
cURL
curl --request POST \
  --url https://api.spotflow.co/api/v1/bulk-plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form skipErrors=true
{}

Required Fields in CSV File

FieldTypeDescription
titlestringName/Title of plan
frequencystringThis simply means how often. Valid frequencies are: daily, weekly, monthly, quarterly, biannually (every 6 months), annually.
amountintergerAmount should be in the subunit of our supported currency i.e your local currency or USD.
currencystringCurrency code (e.g., NGN, USD).
internalReferencestringA unique reference number generated by your company to identify each customer.
pricingOptionsstringSpecify one or more amount or currency for your payment plan.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
file
file
required

CSV file containing bulk subscription data. Must be a .csv file.

skipErrors
enum<boolean>

The unique identifier of the plan whose subscriptions are to be retrieved.

Available options:
true,
false

Response

A JSON array of subscription objects.

The response is of type object.