Create a subscription plan.

post

https://api.test.bictorys.com/billing/v1/subscription-plans

This endpoint enables the creation of a subscription plan for recurring billing. Once a plan is created, customers can subscribe to it.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

Optional. commercial name of the plan.

reference

string

Optional. subscription plan reference.

amount

double

required

recurrent amount to charge for the plan

currency

string

required

currency associated to the amount.

nbrInstallments

integer

Required. number of installments. If there is no limit, ignore it,

installmentIntervalDays

integer

Defaults to 30

Number of days between two installments. Defaults to 30 if not specified.

customerMessage

string

Message intended to customer for installment payment. The message is sent to the customer with the payment link at every occurence. Do no add customer name or grettings in the message.

Headers

X-Amzn-Trace-Id

string

HTTP request identifier allow to trace individual request sent from client to service.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

The caller is not authenticated

403

Access rights not sufficient

201The subscription plan is created successfully

400Bad Request

500Internal Server Error.