Skip to main content
POST
/
api
/
Subscriptions
/
{subscriptionId}
/
payment
Create One Time Payment
curl --request POST \
  --url https://api-sandbox.revolv3.com/api/Subscriptions/{subscriptionId}/payment \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-revolv3-token: <api-key>' \
  --data '
{
  "merchantInvoiceRefId": "06a30ccd-ed68-44d1-bc46-f48681b6d095",
  "invoiceLineItems": [
    {
      "name": "Invoice Line Item 1",
      "description": null,
      "value": 10.99,
      "valueType": "Standard"
    },
    {
      "name": "Invoice Line Item 2",
      "description": null,
      "value": 11.99,
      "valueType": "Standard"
    },
    {
      "name": "Invoice Line Item 3",
      "description": null,
      "value": 12.99,
      "valueType": "Standard"
    }
  ]
}
'
{
  "invoiceId": 1,
  "merchantInvoiceRefId": null,
  "invoiceStatus": 0,
  "invoiceAttemptStatus": "Success",
  "message": null,
  "subtotal": 10.99,
  "taxAmount": 0.98,
  "total": 11.97,
  "paymentMethodTypeId": 0,
  "processorRawResponse": null,
  "responseCode": null
}

Authorizations

x-revolv3-token
string
header
required

Path Parameters

subscriptionId
integer<int64>
required
Required range: 1 <= x <= 1000000000

Body

invoiceLineItems
object[]
required
Required array length: 1 - 50 elements
merchantInvoiceRefId
string | null
Maximum string length: 100

Response

OK

invoiceId
integer<int64>
Required range: 1 <= x <= 1000000000
merchantInvoiceRefId
string | null
Maximum string length: 100
invoiceStatus
enum<string>
Available options:
Paid,
Void,
Pending,
Recycle,
Noncollectable,
Failed,
Refund,
MerchantPaid,
MerchantCancelled,
OneTimePaymentPending,
PartialRefund,
BatchPending,
CapturePending,
RefundPending,
RefundDeclined,
RefundFailed,
RetryPending,
RecurringPending,
MultiCardsPending,
RefundVoid,
PartialRefundVoid
invoiceAttemptStatus
string | null
Maximum string length: 100
message
string | null
Maximum string length: 500
subtotal
number<double>
Required range: 0 <= x <= 10000000
taxAmount
number<double>
Required range: 0 <= x <= 10000000
total
number<double>
Required range: 0 <= x <= 10000000
paymentMethodTypeId
integer<int32>
Required range: 1 <= x <= 1000000000
processorRawResponse
string | null
Maximum string length: 10000
transactionId
string | null
Maximum string length: 100
billInvoiceResponse
object
responseCode
string | null
Maximum string length: 10