Sign in

v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Orders

Create a purchase order

post/customer-billing/orders/purchase

Request body

subscriptionstring
invoicestring
paymentstring
productstring required

Product name

productPricestring required

Product price

amountstring required

Ammount paid

Example request

{
  "subscription": "62420e8278f839f2e4fc6886",
  "invoice": "62420e89e1af4bd4dcd0c5de",
  "payment": "62420e912c0eefa38368a8db",
  "product": "62420e994ad881aea7845682",
  "productPrice": "62420e994ad881aea7845682",
  "amount": "12.99"
}

Response

Returns an OrderOutput object with detailed of the new order.

idstring required

Order ID

createdAtstring required
updatedAtstring required
deletedboolean required
accountstring required
subscriptionstring required
invoicestring required
paymentstring required
productstring required
status'PENDING' | 'ACTIVE' | 'FAILED' | 'UNPAID' | 'CANCELED' required
amountnumber required
customFieldsobject required

Example response

{
  "id": "62420f859d68ae3d2cf769cc",
  "createdAt": "2023-02-09T19:00:05.641Z",
  "updatedAt": "2023-02-09T19:00:05.641Z",
  "account": "62420f70f2b687fb054df722",
  "subscription": "62420f72144f596fcd9f4a5a",
  "invoice": "62420f75044d56cd3398d4f7",
  "payment": "62420f771dcb96a8ac5bae8c",
  "product": "62420f7a0b7bac3955bcd95b",
  "status": "ACTIVE",
  "amount": 122.75,
  "customFields": {
    "fullName": "Jon Doe"
  }
}