Sign in

v1

latestOpenAPI 3.0.02026-08-06363576.8 KB
Customer

Add subscription to a customer

post/customers/{customerReference}/subscriptions/add/

Path parameters

customerReferencestring required

Customer reference (customer_reference) in your system of customer to return

Request body

planinteger required
referencestring required
start_datestring date-time
amountstring

Amount to overwrite the plan amount

discountstring

Discount percentage, from 0 to 100. A value of 10 means 10% discount, calculated on the next charge.

descriptionstring

An optional description for internal purposes.

Example request

{
  "plan": 1,
  "reference": "Sub-12345",
  "start_date": "2022-11-01T00:00:00Z",
  "amount": "1500",
  "discount": "10",
  "description": "My custom note"
}

Response

Successful operation