BIbictorys
Subscription

Returns list of found subscriptions

This API returns the list of found subscription for a merchant.

get/subscriptions/search

Request

Query parameters

referencestring

search by subscription reference

customer_namestring

search subscription by customer name

Headers

X-Amzn-Trace-Idstring

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

Response

returns list of found subscription.

idstring uuid

Unique Identifier of the Subscription Response object

referencestring

Optional. subscription reference.

subscriptionPlanIdstring uuid required

The identifier of the subscription plan chosen by the customer

startDatestring 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.

customerIdstring uuid required

Required. Unique Id of the customer.

notificationChannel'email' | 'sms' | 'whatsApp' | 'none'

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

status'opened' | 'started' | 'cancelled' | 'completed'
nextInstallmentDueDatestring date

date of next installment due date. At 7h00 UTC at the date the request to pay link will be send to the customer

nbrPaidInstallmentsinteger

number of already paid installments.

nbrUnpaidInstallmentsinteger

number of unpaid installments since the beginning.

customerNamestring

Customer Name

currentInstallmentStatus'succeeded' | 'failed' | 'cancelled' | 'pending' | 'processing' | 'reversed' | 'authorized'

status of the transaction

createdAtstring

The merchant entity registration timestamp in our platform in ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS)

updatedAtstring

updated timestamp in our platform in ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS)

Example response

[
  {
    "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "reference": "yourplan_CF34509",
    "subscriptionPlanId": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "startDate": "2023-05-22",
    "customerId": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "status": "completed",
    "nextInstallmentDueDate": "2023-05-22",
    "nbrPaidInstallments": 2,
    "nbrUnpaidInstallments": 1,
    "customerName": "John Dao",
    "createdAt": "2022-03-29 10:00:00,000"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.