Create a subscription

post

https://api.test.bictorys.com/billing/v1/subscriptions

This endpoint allows the creation of a subscription for recurrent billing.

Body Params

reference

string

Optional. subscription reference.

subscriptionPlanId

uuid

required

The identifier of the subscription plan chosen by the customer

startDate

date

required

start date of the first installement. Next installement is due one month after, and so one. the startDate must be today date or in the futur.

customerId

uuid

required

Required. Unique Id of the customer.

notificationChannel

string

enum

Defaults to email

By which means the payment link will be send to the customer

Allowed:

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 is created successfully