Skip to main content
Create Installment
curl --request POST \
  --url https://api.revolv3.com/api/Customers/{customerId}/installments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
  "merchantInstallmentRefId": "1234-5678-9101",
  "billingFrequency": {
    "intervalType": "Days",
    "intervalCount": 1
  },
  "startDate": "2025-10-31T00:00:00Z",
  "trialDuration": 0,
  "trialDurationType": "Days",
  "taxAddress": {
    "addressId": null,
    "addressLine1": "101 Update Street",
    "addressLine2": null,
    "city": "Irvine",
    "state": "CA",
    "postalCode": "92602",
    "phoneNumber": null,
    "email": null,
    "country": "US"
  },
  "installmentItems": [
    {
      "name": "Billing Plan 1",
      "value": 1000,
      "valueType": "Standard"
    },
    {
      "name": "Billing Plan 2",
      "value": 1200,
      "valueType": "Standard"
    }
  ],
  "downPayment": 200,
  "installmentType": "Amount",
  "installmentValue": 500,
  "paymentMethod": {
    "paymentMethodTypes": [
      "CreditCard"
    ],
    "billingAddress": {
      "addressId": null,
      "addressLine1": "100 Main Street",
      "addressLine2": null,
      "city": "Irvine",
      "state": "CA",
      "postalCode": "92602",
      "phoneNumber": null,
      "email": null,
      "country": "US"
    },
    "creditCard": {
      "paymentAccountNumber": "4111111111111111",
      "expirationDate": "1025",
      "securityCode": null,
      "networkToken": null,
      "processingMethodType": "CreditCard"
    },
    "ach": null,
    "googlePay": null,
    "applePay": null,
    "merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-4rf4",
    "billingFirstName": "John",
    "billingLastName": "Doe",
    "billingFullName": null
  },
  "paymentMethodAuthorizationId": null,
  "paymentMethodId": null
}'
{
  "installmentId": 1,
  "customerId": 1,
  "merchantInstallmentRefId": "1234-5678-9101",
  "billingFrequency": {
    "intervalType": "Days",
    "intervalCount": 1
  },
  "installmentType": "Amount",
  "installmentValue": 100.5,
  "downPayment": 800.99,
  "initialBillDate": "31-Oct-25",
  "nextBillDate": "30-Nov-25",
  "taxAddress": {
    "addressId": 1,
    "addressLine1": "112 Main Street",
    "addressLine2": null,
    "city": "Irvine",
    "state": "CA",
    "postalCode": "92602",
    "phoneNumber": null,
    "email": null,
    "country": "US"
  },
  "paymentMethodIds": [
    1
  ],
  "installmentItems": [
    {
      "installmentItemId": 1,
      "installmentId": 0,
      "name": "Installment item 1",
      "value": 1001.99,
      "valueType": "Standard"
    }
  ],
  "billingPlans": [
    {
      "installmentBillingPlanId": 1,
      "installmentId": 1,
      "name": "Installment item 1",
      "value": 800.99,
      "startDate": "31-Oct-25",
      "cyclesRemaining": 0,
      "cycleCount": 1,
      "valueType": "Standart"
    },
    {
      "installmentBillingPlanId": 2,
      "installmentId": 1,
      "name": "Installment item 1",
      "value": 100.5,
      "startDate": "31-Oct-25",
      "cyclesRemaining": 1,
      "cycleCount": 1,
      "valueType": "Standart"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
integer
required

Body

paymentMethod
object
paymentMethodAuthorizationId
integer | null
paymentMethodId
integer | null
merchantInstallmentRefId
string | null
billingFrequency
object
startDate
string<date-time>
trialDuration
integer
trialDurationType
enum<string>
Available options:
Days,
Weeks,
Months,
Years
taxAddress
object
installmentItems
object[] | null
downPayment
number | null
installmentType
string | null
installmentValue
number | null

Response

Created

installmentId
integer
customerId
integer
merchantInstallmentRefId
string | null
billingFrequency
object
installmentType
string | null
installmentValue
number
downPayment
number | null
initialBillDate
string | null
nextBillDate
string | null
taxAddress
object
paymentMethodIds
integer[] | null
installmentItems
object[] | null
billingPlans
object[] | null